Get beneficiary
GET/api/v1/beneficiaries/:id
Fetches the beneficiary details based on provided id
Request
Path Parameters
Unique identifier of the beneficiary
Header Parameters
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Unique identifier for the beneficiary
Short, human-readable ID for the beneficiary
Unique ID from an external system
Possible values: [INDIVIDUAL
, BUSINESS
]
Type of Beneficiary
Full name of the beneficiary
Possible values: Value must match regular expression [A-Z]{3}
Currency used for transactions with the beneficiary
beneficiaryAddress object
Details of the Beneficiary's physical address
Possible values: <= 35 characters
First line of the address
Possible values: <= 35 characters
Second line of the address (if any)
Possible values: <= 35 characters
City of the address
Country of the address
Possible values: <= 35 characters
Postal code of the address
Account number of the beneficiary in the bank
Code of the beneficiary's bank
International Bank Account Number of the beneficiary
Bank Identifier Code of the beneficiary's bank
Identifier of the intermediary bank, if any
Country where the beneficiary's bank is located
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shortId": "BEN123",
"externalId": "EXT123",
"type": "INDIVIDUAL",
"name": "John Doe",
"currency": "USD",
"beneficiaryAddress": {
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "Berlin",
"countryIso2": "GB",
"postalCode": "10115"
},
"accountNumber": "123456789",
"bankCode": "BANK123",
"iban": "GB82WEST12345698765432",
"bic": "DEUTDEFF",
"intermediaryBankIdentifier": "IMB123",
"bankCountry": "Germany"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}