Recipient Management
A recipient is the person or business receiving the payment. To create a recipient, you need their payment currency, name, address, and bank account details. Required fields vary based on recipient type (individual or company), bank country, and payment currency.
API Endpoints
Get Payment Fields
Returns a list of required and optional fields for recipient and bank details based on the specified country and payment currency. Use this information to build recipient forms and validate input before creating recipients or contracts.
GET /v2/payment-fieldsValidate Recipient Details
Validate recipient details upfront using XE's validation rules before creating contracts for a given destination country and payment currency. This helps prevent payment failures during contract creation, reduces processing delays, and saves time spent on corrections. Returns validation results indicating missing required fields, invalid bank account details, or formatting errors.
Use recipient validation to:
- Verify all required recipient information is present
- Confirm bank account details are valid and correctly formatted
- Check compliance with country-specific banking requirements
- Identify missing or invalid data before initiating payments
POST /v2/recipients/validateRegister a Recipient
Validates recipient details against XE’s recipient rules and creates a recipient record. Returns a recipientId for use in contracts and payments. Store recipients for reuse in future transactions.
POST /v2/recipientsUpdate Recipient
Updates an existing recipient record.
PUT /v2/recipients/{recipientId}Delete recipient
Deletes a recipient record. Use this to remove inactive recipients or clean up outdated information. Returns confirmation of deletion.
DELETE /v2/recipients/{recipientId}