Card Account Payouts
✨ New: Card Account Payout Endpoint
You can now initiate payouts from a Card Account to an external bank account. This enables fund withdrawal flows where Organizations need to transfer surplus funds out of their Card Accounts.
| Method | Endpoint | Description |
|---|---|---|
POST | /card-accounts/{cardAccountId}/payout | Create a payout to an external bank account |
Request:
POST /card-accounts/{cardAccountId}/payout
{
"bankAccountId": "550e8400-e29b-41d4-a716-446655440000",
"amount": {
"value": 100000,
"currency": "EUR"
}
}bankAccountId- UUID of the destination bank accountamount.value- Amount in minor units (e.g.,100000= 1,000.00 EUR)amount.currency- ISO 4217 currency code
Response: 201 Created with a Payment object.
Where to get bank accounts: Use the existing GET /organizations/{organizationId}/bank-accounts endpoint to retrieve the list of available external bank accounts for an Organization. The bankAccountId from the response is what you pass to the payout request.
✨ New: Get Card Account by ID
Retrieve details of a specific Card Account directly by its identifier, without needing to list all Card Accounts for an Organization first.
| Method | Endpoint | Description |
|---|---|---|
GET | /card-accounts/{cardAccountId} | Get Card Account details by ID |
✨ New: Get Bank Account by ID
A new endpoint to retrieve a specific bank account by ID will be available shortly:
| Method | Endpoint | Description |
|---|---|---|
GET | /organizations/{organizationId}/bank-accounts/{bankAccountId} | Get bank account details by ID |
Payout Callbacks
A new payoutStatusChanged callback event will notify you when a payout changes status (e.g., processing, completed, failed). Subscribe via the existing callback subscription endpoints.
Constraints
- The destination bank account must already exist for the Organization. Retrieve available accounts via
GET /organizations/{organizationId}/bank-accounts - Amount must be specified in minor currency units
- Payout availability depends on Card Account (funding) type and balance
Questions? Contact your Partner Success manager or email [email protected]
