API reference
Endpoints
Every endpoint has its own page with parameters, a ready-to-run cURL command, and example responses.
Requests marked Bearer need Authorization: Bearer <access_token>;
those marked Idempotent also need an Idempotency-Key header.
Get paid
-
POST
Charge a wallet or issue a bank account
/v1/collections -
GET
Find a payment by your reference
/v1/collections -
GET
Find a payment by id
/v1/collections/{id} -
POST
Create a browser pay link
/v1/checkout/sessions -
GET
Get a pay link
/v1/checkout/sessions/{id} -
GET
Verify any payment by your reference
/v1/transactions/verify/{merchant_reference}
Bank accounts
-
POST
Create customer
/v1/customers -
GET
List customers
/v1/customers -
GET
Get customer
/v1/customers/{id} -
POST
Issue customer bank account
/v1/customers/{id}/virtual-account -
GET
Get customer bank account
/v1/customers/{id}/virtual-account -
POST
Deactivate customer bank account
/v1/customers/{id}/virtual-account/deactivate -
GET
List payments into customer bank account
/v1/customers/{id}/collections -
POST
Issue merchant standing bank account
/v1/virtual-accounts/merchant -
GET
Get merchant standing bank account
/v1/virtual-accounts/merchant