Create pay run

Beneficiaries

Every Payable requires a beneficiary object describing the recipient of the payment.

$type - Required for international payments, optional for domestic payments. Value should be either Individual or Organisation depending on whether the beneficiary is a person or a company/organisation.

🚧
$type is JSON metadata and must be the top property
This property describes the type of the beneficiary object, which in turn affects the required properties of the object. Metadata naming convention is to begin with $ (which is mandatory - $type is valid, type is not valid), and metadata properties must be the first properties in the object.
Be mindful of how your code objects are serialised to JSON in this regard.

companyName / firstName + lastName - Required for international payments, optional for domestic payments. companyName if $type is Organisation, firstName and lastName if $type is Individual.
address - Postal address. Required for most international payments, optional for domestic payments. Country must be an ISO 3166-1 alpha-2 code.
bankAccount - Required for all payments
- accountCurrency - Required for all payments. Must be an ISO 4217 code.
- accountRoutingName - Required for all payments.
- country - Required for all payments. Must be an ISO 3166-1 alpha-2 code.
- Bank account routing address components e.g. gbSortCode, iban: Enough of these must be supplied to satisfy at least one of the groups returned by Get Beneficiary Bank Account Fields.

Examples

Domestic Payments

{
  "partnerEntityId": "4b0e3c3e-43dc-409e-9b84-603fb1885a62",
  "payerBankAccountId": "a5b256c6-d6cc-4465-aa03-0decfff03339",
  "payables": [
    {
      "partnerEntityId": "368e9bdf-ef1f-459a-b005-8e64100f5269",
      "recipientAmount": {
        "amountInMinorUnits": 2000,
        "currencyCode": "GBP"
      },
      "reference": "testdomestic123",
      "beneficiary": {
        "bankAccount": {
          "accountCurrency": "GBP",
          "accountRoutingName": "John Doe",
          "country": "GB",
          "gbSortCode": "123456",
          "gbAccountNumber": "12345678"
        }
      }
    }
  ]
}

International Payments

{
  "partnerEntityId": "32ef0825-f17b-4204-9395-f62382a3729e",
  "payerBankAccountId": "a5b256c6-d6cc-4465-aa03-0decfff03339",
  "payables": [
    {
      "partnerEntityId": "75aa8041-5839-4c86-b37e-ba58c21192a3",
      "recipientAmount": {
        "amountInMinorUnits": 5008,
        "currencyCode": "EUR"
      },
      "reference": "testfxfz3n",
      "beneficiary": {
        "$type": "Organisation",
        "address": {
          "street": "42 Rue de la République",
          "city": "Paris",
          "region": "Île-de-France",
          "country": "FR",
          "postalCode": "75001"
        },
        "bankAccount": {
          "accountCurrency": "EUR",
          "accountRoutingName": "Example Co",
          "country": "FR",
          "iban": "FR7630006000011234567890189"
        },
        "companyName": "Example Co. France"
      }
    },
    {
      "partnerEntityId": "26facc73-e3bc-4328-9eab-dd05147fd992",
      "recipientAmount": {
        "amountInMinorUnits": 6006,
        "currencyCode": "EUR"
      },
      "reference": "testfxK695",
      "beneficiary": {
        "$type": "Individual",
        "address": {
          "street": "52 RUE DES FLEURS",
          "city": "Paris",
          "region": "Île-de-France",
          "country": "FR",
          "postalCode": "75001"
        },
        "bankAccount": {
          "accountCurrency": "EUR",
          "accountRoutingName": "John Doe",
          "country": "FR",
          "iban": "FR1420041010050500013M02606"
        },
        "firstName": "John",
        "lastName": "Doe"
      }
    }
  ]
}