The recipients are beneficiaries to whom payments can be issued from Merge Accounts. You could add recipients on the Merge platform to transfer funds from your account to your account or others. It is mandatory to register the beneficiary before issuing the payout.
There are two types of recipients: person and business.
The Recipient object is composed of the attributes listed below:
id string
The unique identifier (UUID) of the recipient.
Example: af221980-450b-11ed-b878-0242ac120002
summary string
A summary of the recipient's account that is shown with the account holder's name on the Merge platform.
Example: GBP Account
account_number string
The number associated with the recipient's account that will be used for sending fiat money.
Example: 12345678
sort_code string
The sort code associated with the recipient's account. It is a 6 digit number that identifies both the bank (in the first digit or the first two digits) and the branch where the account is held.
Example: 000000
nickname string
The nickname associated with the recipient.
Example: John Smith
email string
The recipient's e-mail.
Example: [email protected]
currency enum
The currency of the recipient's account.
Possible enum values: GBP or EUR
country string
Two-letter ISO 3166-1 code representing the country where recipient's account is located in.
Example: GB
created_at date-time
The date and time that the recipient was created.
Example: 2022-10-05T22:36:19.612440+00:00
updated_at date-time
The date and time that the recipient was last updated.
Example: 2022-10-05T22:36:19.612440+00:00
bic string
The business identifier code (BIC) associated with your EUR account. The BIC is an 8 to 11-character code consisting of the business party prefix (four alphanumeric), the country code (two alphabetic), and the business party suffix. This attribute is optional for EUR accounts.
Example: MOCKGB21
iban string
The International Bank Account Number (IBAN), associated with your EUR account. The IBAN number consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters. This attribute is only mandatory for EUR accounts.
Example: GB60MOCK00000002166663
account_holder_name string
The account holder's full name to be added to the Recipient. This is the name that will appear on the transaction's statement when funds are sent from your account to the recipient's account.
Example: Laura Curtis
first_name string
The account holder's first name. This attribute is sent in the API response for a person-type recipient with an EUR account.
Example: Laura
last_name string
The account holder's last name. This attribute is sent in the API response for a person-type recipient with an EUR account.
Example: Curtis
company_name string
The company name to be added to the Recipient. This attribute is sent in the API request and response for a business-type recipient.
Example: Merge
member_id string
The unique identifier of the member.
Example: af221980-450b-11ed-b878-0242ac120002
member_type string
The type of the associated member, the value can be a business or a linked_individual.
Possible values: business or linked_individual