v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payee Invitation

Initiate Payee Creation

Initiate the process of creating 1 to 2000 payees in a batch

Use the batchId in the response to query for status.

In addition to standard semantic validations, a 400 will also result if:

there is a duplicate remote id within the batch
there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch).

The validation at this stage is intra-batch only.

Validation against payees who have already been invited occurs subsequently during processing of the batch.

post/v4/payees

Request body

payorIdstring required

Example request

{
  "payees": [
    {
      "address": {
        "country": "US",
        "countyOrProvince": "FL",
        "line4": "line4",
        "city": "Key West",
        "line3": "line3",
        "line2": "line2",
        "line1": "500 Duval St",
        "zipOrPostcode": "33945"
      },
      "individual": {
        "name": {
          "firstName": "Bob",
          "lastName": "Smith",
          "otherNames": "H",
          "title": "Mr"
        },
        "nationalIdentification": "SA211123K",
        "dateOfBirth": "1970-05-20T00:00:00.000+0000"
      },
      "challenge": {
        "description": "challenge description",
        "value": "11984567"
      },
      "language": "en-US",
      "company": {
        "taxId": "123123123",
        "name": "ABC Group Plc",
        "operatingName": "ABC Co"
      },
      "email": "bob@example.com",
      "remoteId": "Remote ID",
      "paymentChannel": {
        "paymentChannelName": "My Payment Channel",
        "routingNumber": "XXXXX6789",
        "accountName": "My account",
        "countryCode": "US",
        "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
        "currency": "USD",
        "accountNumber": "XXXXXX5678"
      }
    },
    {
      "address": {
        "country": "US",
        "countyOrProvince": "FL",
        "line4": "line4",
        "city": "Key West",
        "line3": "line3",
        "line2": "line2",
        "line1": "500 Duval St",
        "zipOrPostcode": "33945"
      },
      "individual": {
        "name": {
          "firstName": "Bob",
          "lastName": "Smith",
          "otherNames": "H",
          "title": "Mr"
        },
        "nationalIdentification": "SA211123K",
        "dateOfBirth": "1970-05-20T00:00:00.000+0000"
      },
      "challenge": {
        "description": "challenge description",
        "value": "11984567"
      },
      "language": "en-US",
      "company": {
        "taxId": "123123123",
        "name": "ABC Group Plc",
        "operatingName": "ABC Co"
      },
      "email": "bob@example.com",
      "remoteId": "Remote ID",
      "paymentChannel": {
        "paymentChannelName": "My Payment Channel",
        "routingNumber": "XXXXX6789",
        "accountName": "My account",
        "countryCode": "US",
        "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
        "currency": "USD",
        "accountNumber": "XXXXXX5678"
      }
    }
  ],
  "payorId": "9ac75325-5dcd-42d5-b992-175d7e0a035e"
}

Response

HTTP Created. Body created only on CSV requests

batchIdstring uuid

Example response

{
  "batchId": "cb6ff8c6-85e9-45a6-b7d9-d05305db67f3",
  "rejectedCsvRows": [
    {
      "rejectedContent": "unable,to,process,csv,line",
      "lineNumber": 3,
      "message": "rejected message 1"
    },
    {
      "rejectedContent": "unable,to,process,csv,line",
      "lineNumber": 3,
      "message": "rejected message 1"
    }
  ]
}