VEvelopaymentsapi
Payee Invitation

Query Batch Status

Changed on

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 ).

get/v4/payees/batch/{batchId}

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

batchIdstring uuid required

Batch Id

Response

Get Batch Status

statusstring

Batch Status. One of the following values: SUBMITTED, ACCEPTED

failureCountinteger
pendingCountinteger

Example response

{
  "failures": [
    {
      "failedSubmission": {
        "payorRefs": [
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "payableStatus": true,
            "invitationStatus": "invitationStatus",
            "payableIssues": [
              {
                "code": "3",
                "message": "payee-disabled"
              },
              {
                "code": "3",
                "message": "payee-disabled"
              }
            ],
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          },
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "payableStatus": true,
            "invitationStatus": "invitationStatus",
            "payableIssues": [
              {
                "code": "3",
                "message": "payee-disabled"
              },
              {
                "code": "3",
                "message": "payee-disabled"
              }
            ],
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          }
        ],
        "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"
        },
        "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
        "type": "type",
        "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"
        }
      },
      "failureMessage": "failure reason"
    },
    {
      "failedSubmission": {
        "payorRefs": [
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "payableStatus": true,
            "invitationStatus": "invitationStatus",
            "payableIssues": [
              {
                "code": "3",
                "message": "payee-disabled"
              },
              {
                "code": "3",
                "message": "payee-disabled"
              }
            ],
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          },
          {
            "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
            "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
            "payableStatus": true,
            "invitationStatus": "invitationStatus",
            "payableIssues": [
              {
                "code": "3",
                "message": "payee-disabled"
              },
              {
                "code": "3",
                "message": "payee-disabled"
              }
            ],
            "remoteId": "uniqueIdForRemoteEntity",
            "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
          }
        ],
        "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"
        },
        "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
        "type": "type",
        "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"
        }
      },
      "failureMessage": "failure reason"
    }
  ],
  "pendingCount": 2,
  "failureCount": 2,
  "status": "status"
}

Changes

  • 05c3f09fc50aRevision changes
    • breaking

      the //// response property's minLength was decreased from 6 to 4 for the response status

    • breaking

      the //// response property's minLength was decreased from 6 to 4 for the response status

  • 1e7a1734a45cRevision changes
    • info

      removed the ACCEPTED enum value from the ///// response property for the response status

    • info

      removed the ACCEPTED enum value from the response property for the response status

    • info

      removed the Company enum value from the /// response property for the response status

    • info

      removed the DECLINED enum value from the ///// response property for the response status

    • info

      removed the Individual enum value from the /// response property for the response status

    • info

      removed the PENDING enum value from the ///// response property for the response status

    • info

      removed the SUBMITTED enum value from the response property for the response status