Download OpenAPI specification:
This is an API documentation for beneficiaries endpoints of Chimoney API following the OpenAPI Specifications
Retrieve a list of all beneficiaries optionally filtered by subaccount ID.
| subaccountId | string Optional subaccount ID |
{- "status": "success",
- "message": "Beneficiaries retrieved successfully",
- "data": [
- {
- "id": "12345",
- "accountNumber": "00123456789",
- "bankCurrency": {
- "curr": "NGN"
}, - "channel": "bank-transfer",
- "createdDate": "2023-10-01T12:34:56Z"
}
]
}Add a new bank beneficiary to the system
object |
{- "beneficiaryData": {
- "accountHolderName": "John Doe",
- "accountHolderAddress1": "123 Main St",
- "accountHolderAddress2": "Apt 4B",
- "accountHolderCity": "New York",
- "accountHolderRegion": "NEW YORK",
- "accountHolderPostal": "10001",
- "bankName": "Test Bank",
- "bankCity": "New York",
- "bankAddressLine1": "456 Bank St",
- "bankRegion": "NEW YORK",
- "bankPostal": "10001",
- "accountNumber": "12345678",
- "routingCode": "123456789",
- "classification": "Individual",
- "preferredMethod": "W",
- "currency": "USD",
- "country": "US"
}
}{- "status": "success",
- "message": "Beneficiary created successfully",
- "data": {
- "id": "12345",
- "benID": "BENE12345",
- "templateId": "TEMPLATE12345"
}
}