API reference
The Partner API is a JSON over HTTPS API. Every route is under / and every field is camelCase.
Base URL
| Environment | Base URL |
|---|---|
| Sandbox | https:/ |
| Production | https:/ |
A full route is the base URL plus the endpoint path, for example https:/.
Authentication
Send an access token from the token endpoint on every request.
Authorization: Bearer <access_token>
GET routes need the partner. scope. POST and PATCH routes need partner.. See Scopes.
Resources
Create, update and look up business customers and their owners.
Upload supporting documents for compliance review.
Read the compliance outcome for a customer.
Price a payout before you send it.
Save the bank accounts you and your customers pay out to.
Show deposit details and read balances for your wallets.
Receive signed events instead of polling.
Responses
Every response uses one body, success or failure, except a 500.
{
"value": { },
"isSuccess": true,
"isFailure": false,
"error": { "code": "", "name": "" },
"title": null,
"traceId": "0HN..."
}
Read value when isSuccess is true. On success error is empty and title is null.
Errors
A failure has the same body, with value set to null and the HTTP status set by the error. Branch on error.. The error. and title text can change.
{
"value": null,
"isSuccess": false,
"isFailure": true,
"error": {
"code": "Customer.NotFound",
"name": "Partner customer with ID '3fa85f64-5717-4562-b3fc-2c963f66afa6' not found"
},
"title": "Resource not found",
"traceId": "0HN..."
}
Include traceId when you contact support.
A field that fails validation returns 400 with code ValidationControl.. Every field message is joined into error.. A body that is not valid JSON, a value of the wrong type, or a code the API does not know returns 400 with code Request.. Its error. names the field and what it accepts, for example industry: must be one of: Retail, FinancialServices, … or registrationDate: must be a date in the format yyyy-MM-dd.
A 500 is an RFC 7807 problem response instead:
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
"title": "An unexpected error occurred",
"status": 500,
"detail": "An unexpected error occurred. Please reference error ID: 3e1b... for follow-up.",
"code": "InternalServerError",
"traceId": "0HN..."
}
Common errors
These can come from any endpoint. Each endpoint page lists its own errors.
| Code | HTTP | Meaning |
|---|---|---|
Auth. | 401 | The token is missing, invalid or expired. Request a new one. |
Auth. | 403 | The token is not a partner credential, or lacks the scope this route needs. |
| 429 | Rate limit exceeded. See Rate limits. | |
Partner. | 401 | The token has no partner identity. Contact support. |
Partner. | 404 | Your partner account no longer exists. Contact support. |
Partner. | 409 | Your partner account is not approved to onboard customers yet. |
Partner. | 403 | The customerId is a business that is not one of yours. Do not retry. |
Customer. | 404 | No customer has this id. |
Customer. | 400 | The id is a customer that is not a business. |
ValidationControl. | 400 | A request field is invalid. Fix it using error.. |
Request. | 400 | The body is not valid JSON, a value has the wrong type, or a code is unknown. error. names the field and what it accepts. |
Gateway errors for 401, 429 and 503 use a different body. See Errors.