Sign in
Payee Invitation

Query Batch Status

Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).

Please use V3 instead

get/v2/payees/batch/{batchId}

Path parameters

batchIdstring uuid required

Batch Id

Response

Get Batch Status

status'SUBMITTED' | 'ACCEPTED'

Batch Status

failureCountinteger
pendingCountinteger

Example response

{
  "failures": [
    {
      "failedSubmission": {
        "payorRefs": [
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "invitationStatus": "ACCEPTED",
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          },
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "invitationStatus": "ACCEPTED",
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          }
        ],
        "country": "US",
        "cellphoneNumber": "1234567890",
        "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": "A",
            "title": "Mr"
          },
          "nationalIdentification": "AB123456C",
          "dateOfBirth": "1985-01-01"
        },
        "displayName": "Bob",
        "created": "2019-01-20T09:00:00Z",
        "type": "Individual",
        "gracePeriodEndDate": "2019-01-20T00:00:00.000+0000",
        "paymentChannel": {
          "paymentChannelName": "paymentChannelName",
          "routingNumber": "XXXXX6789",
          "accountName": "My account",
          "countryCode": "US",
          "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
          "currency": "USD",
          "accountNumber": "XXXXXX5678"
        },
        "remoteId": "remoteId123",
        "marketingOptIns": [
          {
            "optedIn": true,
            "timestamp": "2019-01-20T09:00:00Z"
          },
          {
            "optedIn": true,
            "timestamp": "2019-01-20T09:00:00Z"
          }
        ],
        "watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00",
        "challenge": {
          "description": "challenge description",
          "value": "challenge test"
        },
        "company": {
          "taxId": "123",
          "name": "ABC Ltd",
          "operatingName": "ABC"
        },
        "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
        "email": "bob@example.com",
        "acceptTermsAndConditionsTimestamp": "2019-01-20T09:00:00Z"
      },
      "failureMessage": "failure reason"
    },
    {
      "failedSubmission": {
        "payorRefs": [
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "invitationStatus": "ACCEPTED",
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          },
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "invitationStatus": "ACCEPTED",
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          }
        ],
        "country": "US",
        "cellphoneNumber": "1234567890",
        "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": "A",
            "title": "Mr"
          },
          "nationalIdentification": "AB123456C",
          "dateOfBirth": "1985-01-01"
        },
        "displayName": "Bob",
        "created": "2019-01-20T09:00:00Z",
        "type": "Individual",
        "gracePeriodEndDate": "2019-01-20T00:00:00.000+0000",
        "paymentChannel": {
          "paymentChannelName": "paymentChannelName",
          "routingNumber": "XXXXX6789",
          "accountName": "My account",
          "countryCode": "US",
          "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
          "currency": "USD",
          "accountNumber": "XXXXXX5678"
        },
        "remoteId": "remoteId123",
        "marketingOptIns": [
          {
            "optedIn": true,
            "timestamp": "2019-01-20T09:00:00Z"
          },
          {
            "optedIn": true,
            "timestamp": "2019-01-20T09:00:00Z"
          }
        ],
        "watchlistStatusUpdatedTimestamp": "2019-01-20T09:00:00+00:00",
        "challenge": {
          "description": "challenge description",
          "value": "challenge test"
        },
        "company": {
          "taxId": "123",
          "name": "ABC Ltd",
          "operatingName": "ABC"
        },
        "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
        "email": "bob@example.com",
        "acceptTermsAndConditionsTimestamp": "2019-01-20T09:00:00Z"
      },
      "failureMessage": "failure reason"
    }
  ],
  "pendingCount": 6,
  "failureCount": 0,
  "status": "SUBMITTED"
}

Changes