Concepts
Recipients
Recipients are third parties that a customer pays.
Recipients represent third parties a customer pays, such as vendors, contractors, employees, or counterparties. Recipient bank accounts are stored separately from customer-owned external accounts so first-party and third-party payouts stay explicit.
API Reference
| Operation | Use it for |
|---|---|
POST /v1/customers/{customerId}/recipients | Create a recipient. |
GET /v1/customers/{customerId}/recipients | List recipients. |
GET /v1/customers/{customerId}/recipients/{recipientId} | Retrieve a recipient. |
PATCH /v1/customers/{customerId}/recipients/{recipientId} | Update a recipient. |
DELETE /v1/customers/{customerId}/recipients/{recipientId} | Archive a recipient. |
POST /v1/customers/{customerId}/recipients/{recipientId}/accounts | Create a recipient bank account. |
GET /v1/customers/{customerId}/recipients/{recipientId}/accounts | List recipient bank accounts. |
GET /v1/customers/{customerId}/recipients/{recipientId}/accounts/{recipientAccountId} | Retrieve a recipient bank account. |
DELETE /v1/customers/{customerId}/recipients/{recipientId}/accounts/{recipientAccountId} | Archive a recipient bank account. |