PayPlug - Atako

Let your agents read payments, refunds and installment plans in PayPlug, send a customer a hosted payment request and cancel an unpaid one. Nothing that moves money (no refund, capture or saved-card charge). Test the connection with a test secret key (sk_test_…) first.

Connection

Authentication: API key (Secret key).

Sign in at portal.payplug.com → My account → API Credentials, and copy the secret key (starts with sk_). A test key (sk_test_…) works on test data only — use it to try the connection; the live key (sk_live_…) acts on real payments. A PayPlug secret key has no scopes: it acts for the whole account.See PayPlug’s documentation.

Read actions (5)

Action	Description
`get_installment_plan`	Retrieve an installment plan (installment_plan_id: inst_…, found in a payment’s installment_plan_id): is_active, is_fully_paid, schedule of installments, billing. PayPlug has no endpoint to list installment plans.
`get_payment`	Retrieve a payment by its ID (pay_…): amount and amount_refunded in cents, is_paid, is_refunded, failure, hosted_payment.payment_url, billing, installment_plan_id, metadata.
`get_refund`	Retrieve one refund (refund_id: re_…) of a payment (payment_id: pay_…); list_refunds gives the IDs.
`list_payments`	List payments of the key’s mode (test key: test payments, live key: live payments). Only payments created through the API are listed (payments created in the PayPlug portal are not). Optional: page (integer, starts at 0), per_page (1–100; without page, the last 10 payments are returned). Amounts are in cents. Response: { page, per_page, has_more, data: [payment] }.
`list_refunds`	List the refunds of a payment (payment_id: pay_…). Optional: page (integer, starts at 0), per_page (1–100). Read only — refunds cannot be created from here.

Write actions (2)

Action	Description
`abort_payment`	Abort (cancel) an unpaid payment request so its payment page can no longer be paid. Argument: payment_id (string, pay_…). Impossible on a payment already paid or failed. Nothing else about the payment can be changed through this action.
`create_hosted_payment`	Create a hosted payment REQUEST: PayPlug returns a payment page (hosted_payment.payment_url in the response) for the customer to pay; nothing is charged by this call. Arguments: amount (integer in cents, 30–2000000, e.g. 4207 for 42.07 €); currency (“EUR”, the only currency PayPlug supports); billing (object, required: email (string, required — the customer’s address), optional first_name, last_name, title (“mr” \| “mrs” \| “miss”), mobile_phone_number (E.164 string, required by PayPlug when sent_by is “SMS”), landline_phone_number, address1, address2, company_name, postcode, city, state, country (2-letter ISO code), language (“fr” \| “en” \| “it”)); hosted_payment (object, required: return_url (string, http(s) URL the customer returns to after the page, paid or not), cancel_url (string, http(s) URL after “Cancel payment”), sent_by (“EMAIL” \| “SMS” \| “OTHER”: EMAIL/SMS makes PayPlug send the link to the billing email/phone and keeps it valid 7 days, OTHER means you share the link yourself; without sent_by the link expires after 15 minutes) — all optional inside); optional shipping (object, same fields as billing plus delivery_type: “BILLING” \| “VERIFIED” \| “NEW” \| “SHIP_TO_STORE” \| “DIGITAL_GOODS” \| “TRAVEL_OR_EVENT” \| “OTHER”; sent as {} when omitted); optional description (string, max 80 chars, shown to the customer); optional metadata (flat JSON object of your own keys); optional notification_url (string, http(s)); optional force_3ds (boolean). No deferred payment, saved card or alternative payment method.

Permissions

Every action above must be explicitly granted to an agent before it can be used. See Permissions for the grant model and Security for how credentials are protected.

Last reviewed against the provider API: September 2026.