| Method | Path | Description |
|---|---|---|
| GET | /customers/{customer_id}/accounts/{account_id}/agreements | List Agreements |
| GET | /customers/{customer_id}/accounts/{account_id}/agreements/{agreement_id} | Get Agreement |
| POST | /customers/{customer_id}/accounts/{account_id}/agreements/actions | Submit Agreement Actions |
| POST | /customers/{customer_id}/accounts | Create Account |
| GET | /customers/{customer_id}/accounts | List Accounts |
| GET | /customers/{customer_id}/accounts/{account_id} | Get Account |
| PATCH | /customers/{customer_id}/accounts/{account_id} | Update Account |
| POST | /customers/{customer_id}/accounts/{account_id}/associated-persons | Create Associated Person |
| GET | /customers/{customer_id}/accounts/{account_id}/associated-persons | List Associated Persons |
| GET | /customers/{customer_id}/accounts/{account_id}/associated-persons/{ap_id} | Get Associated Person |
| PATCH | /customers/{customer_id}/accounts/{account_id}/associated-persons/{ap_id} | Update Associated Person |
| POST | /customers/{customer_id}/accounts/{account_id}/associated-persons/{ap_id}/verification-session | Create Verification Session |
| POST | /customers/{customer_id}/accounts/{account_id}/documents | Upload Account Document |
| GET | /customers/{customer_id}/accounts/{account_id}/documents | List Documents |
| GET | /customers/{customer_id}/accounts/{account_id}/documents/{document_id} | Get Document |
| POST | /accounts/{account_id}/beneficiaries | Create Beneficiary |
| GET | /accounts/{account_id}/beneficiaries | List Beneficiaries |
| GET | /accounts/{account_id}/beneficiaries/{id} | Get Beneficiary |
| PATCH | /accounts/{account_id}/beneficiaries/{id} | Update Beneficiary |
| POST | /accounts/{account_id}/beneficiaries/{id}/disable | Disable Beneficiary |
| POST | /accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations | Create Payment Destination |
| GET | /accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations | List Payment Destinations |
| GET | /accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id} | Get Payment Destination |
| PATCH | /accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id} | Update Payment Destination |
| POST | /accounts/{account_id}/beneficiaries/{beneficiary_id}/payment-destinations/{id}/disable | Disable Payment Destination |
| POST | /accounts/{id}/virtual-accounts | Create Virtual Account |
| GET | /accounts/{id}/virtual-accounts | List Virtual Accounts |
| GET | /virtual-accounts/{id} | Get Virtual Account |
| POST | /virtual-accounts/{id}/disable | Disable Virtual Account |
| GET | /accounts/{account_id}/deposits | List Deposits |
| GET | /accounts/{account_id}/deposits/{deposit_id} | Get Deposit |
| POST | /accounts/{account_id}/transfers | Create Transfer |
| GET | /accounts/{account_id}/transfers | List Transfers |
| GET | /accounts/{account_id}/transfers/{transfer_id} | Get Transfer |
| POST | /accounts/{account_id}/payments | Create Payment |
| GET | /accounts/{account_id}/payments | List Payments |
| GET | /accounts/{account_id}/payments/{payment_id} | Get Payment |
| POST | /customers/{customer_id}/webhook-endpoints | Create Webhook Endpoint |
| GET | /customers/{customer_id}/webhook-endpoints | List Webhook Endpoints |
| PATCH | /customers/{customer_id}/webhook-endpoints/{id} | Update Webhook Endpoint |
| POST | /customers/{customer_id}/webhook-endpoints/{id}/disable | Disable Webhook Endpoint |
Getting Started
Endpoint Summary
The full Platform API surface — 41 endpoints across 11 resource groups
The full Platform API surface — 41 endpoints across 11 resource groups. Click any row’s description to jump to the detailed reference.