Get Beneficiary
GET/beneficiaries/:beneficiaryIdDescription
Retrieve a beneficiary by its unique identifier, including its current registration status.
Headers
| Header | Description | Required |
|---|---|---|
| Authorization | Bearer token with your API key | yes |
Path Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| beneficiaryId | string | The unique identifier of the beneficiary. | yes |
Example Request
const response = await fetch('https://checkout-api.exodus-int.com/beneficiaries/ben_1a2b3c', {
headers: {
Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
},
});Response
SUCCESSFUL RESPONSE
{
"id": "ben_1a2b3c",
"object": "beneficiary",
"name": "Acme Inc",
"status": "registered",
"bank_account": { "type": "SEPA", "iban_last4": "3000", "country": "DE" },
"created_at": "2026-06-04T12:00:00Z"
}Error Responses
NOT FOUND
{
"error": {
"type": "not_found",
"message": "Beneficiary not found"
}
}