Recipients

A recipient (also known as a beneficiary) is the person or business receiving a payment.

When creating a transaction, you can specify the recipient in one of two ways:

1. Inline recipient – include the recipient details directly in the transaction request.
2. Stored recipient – reference a previously stored recipient using its identifier.

Stored recipients allow you to reuse recipient details across multiple transactions.

Notable fields

"Account": {
  "SortCode": "112233",
  "AccountNumber": "22233445"
}

Inline recipient

To provide recipient details directly in the transaction request, include a Recipient object.

Example:

{
  "SendValue": 100.00,
  "SendCurrency": "EUR",
  "Recipient": {
    "Name": "Victoria Lau",
    "Country": "GB",
    "Currency": "GBP",
    "RecipientReference": "Claim-51837",
    "Account": {
      "SortCode": "112233",
      "AccountNumber": "22233445"
    }
  }
}

The following fields are required when specifying a recipient inline:

• Name
• Country
• Currency
• RecipientReference
• Account

The required account fields depend on the payment route and destination country. For more information, see Rules.

Stored recipient

Instead of including full recipient details, you can reference a stored recipient.

For more information, see Manage stored recipients.