Sign in
Payee Invitation

Initiate Payee Creation

Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).

post/v3/payees

Request body

payorIdstring required

Example request

{
  "payorId": "9ac75325-5dcd-42d5-b992-175d7e0a035e",
  "payees": [
    {
      "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
      "payorRefs": [
        {
          "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
          "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
          "invitationStatus": "ACCEPTED",
          "remoteId": "uniqueIdForRemoteEntity",
          "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
        }
      ],
      "email": "bob@example.com",
      "remoteId": "Remote ID",
      "address": {
        "line1": "500 Duval St",
        "city": "Key West",
        "countyOrProvince": "FL",
        "zipOrPostcode": "33945",
        "country": "US"
      },
      "paymentChannel": {
        "paymentChannelName": "My Payment Channel",
        "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
        "accountNumber": "XXXXXX5678",
        "routingNumber": "XXXXX6789",
        "countryCode": "US",
        "accountName": "My account"
      },
      "challenge": {
        "description": "challenge description",
        "value": "challenge test"
      },
      "company": {
        "taxId": "123",
        "name": "ABC Ltd",
        "operatingName": "ABC"
      },
      "individual": {
        "name": {
          "title": "Mr",
          "firstName": "Bob",
          "otherNames": "H",
          "lastName": "Smith"
        },
        "nationalIdentification": "SA211123K",
        "dateOfBirth": "1970-05-20"
      }
    }
  ]
}

Response

HTTP Created. Body created only on CSV requests

batchIdstring uuid

Example response

{
  "batchId": "cb6ff8c6-85e9-45a6-b7d9-d05305db67f3",
  "rejectedCsvRows": [
    {
      "rejectedContent": "remoteId1,USD,-123.45,ref1",
      "lineNumber": 3,
      "message": "rejected message 1"
    },
    {
      "rejectedContent": "remoteId1,USD,-123.45,ref1",
      "lineNumber": 3,
      "message": "rejected message 1"
    }
  ]
}

Changes