Recipients
Recipients overview
API reference for managing payment recipients
Overview
The Recipients API provides functionality for managing:- Payment recipient details
- Bank account information
- Intermediate banks
- Contact information
- Recipient search
Core Concepts
Recipient Types
| Type | Description |
|---|---|
business | Corporate recipients |
personal | Individual recipients |
Bank Properties
| Field | Description | Required |
|---|---|---|
iban | Account number | Yes |
bic | Bank identifier | Yes |
bank | Bank name | Yes |
intermediate_bic | Intermediary BIC | No |
intermediate_bank | Intermediary name | No |
intermediate_route | Routing method | No |
Contact Details
| Field | Description | Required |
|---|---|---|
legal_name | Full name | Yes |
legal_address | Street address | Yes |
city | City | Yes |
country | Country code | Yes |
email | Email address | No |
phone | Phone number | No |
reference | External reference | No |
Validation Rules
Bank Validation
| Field | Format | Example |
|---|---|---|
bic | 8 or 11 chars | UBSWCHZH80A |
bank_code | 4 letters | UBSW |
country_code | 2 letters | CH |
location_code | 2 alphanumeric | ZH |
branch_code | 3 alphanumeric | 80A |
Country Rules
- ISO 3166-1 alpha-2 format
- Must be active country
- Valid for IBAN format
- Matches BIC country
Reference Rules
- Unique per customer
- Alphanumeric allowed
- Max length: 50 chars
- Case sensitive
Security Requirements
- Customer-scoped access
- Role-based permissions
- Audit logging
- Data validation
See individual endpoint documentation for detailed request/response formats and examples.