Query Batch Status

Changed on Jul 13, 2026

Use v4 instead

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/v3/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": "challenge test"
        },
        "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": "challenge test"
        },
        "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

Jul 13, 202605c3f09fc50a Revision 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
Aug 10, 20221e7a1734a45c Revision 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 AD enum value from the //// response property for the response status
- info
  removed the AE enum value from the //// response property for the response status
- info
  removed the AF enum value from the //// response property for the response status
- info
  removed the AG enum value from the //// response property for the response status
- info
  removed the AI enum value from the //// response property for the response status
- info
  removed the AL enum value from the //// response property for the response status
- info
  removed the AM enum value from the //// response property for the response status
- info
  removed the AO enum value from the //// response property for the response status
- info
  removed the AQ enum value from the //// response property for the response status
- info
  removed the AR enum value from the //// response property for the response status
- info
  removed the AS enum value from the //// response property for the response status
- info
  removed the AT enum value from the //// response property for the response status
- info
  removed the AU enum value from the //// response property for the response status
- info
  removed the AW enum value from the //// response property for the response status
- info
  removed the AX enum value from the //// response property for the response status
- info
  removed the AZ enum value from the //// response property for the response status
- info
  removed the BA enum value from the //// response property for the response status
- info
  removed the BB enum value from the //// response property for the response status
- info
  removed the BD enum value from the //// response property for the response status
- info
  removed the BE enum value from the //// response property for the response status
- info
  removed the BF enum value from the //// response property for the response status
- info
  removed the BG enum value from the //// response property for the response status
- info
  removed the BH enum value from the //// response property for the response status
- info
  removed the BI enum value from the //// response property for the response status
- info
  removed the BJ enum value from the //// response property for the response status
- info
  removed the BL enum value from the //// response property for the response status
- info
  removed the BM enum value from the //// response property for the response status
- info
  removed the BN enum value from the //// response property for the response status
- info
  removed the BO enum value from the //// response property for the response status
- info
  removed the BQ enum value from the //// response property for the response status
- info
  removed the BR enum value from the //// response property for the response status
- info
  removed the BS enum value from the //// response property for the response status
- info
  removed the BT enum value from the //// response property for the response status
- info
  removed the BV enum value from the //// response property for the response status
- info
  removed the BW enum value from the //// response property for the response status
- info
  removed the BY enum value from the //// response property for the response status
- info
  removed the BZ enum value from the //// response property for the response status
- info
  removed the CA enum value from the //// response property for the response status
- info
  removed the CC enum value from the //// response property for the response status
- info
  removed the CD enum value from the //// response property for the response status
- info
  removed the CF enum value from the //// response property for the response status
- info
  removed the CG enum value from the //// response property for the response status
- info
  removed the CH enum value from the //// response property for the response status
- info
  removed the CI enum value from the //// response property for the response status
- info
  removed the CK enum value from the //// response property for the response status
- info
  removed the CL enum value from the //// response property for the response status
- info
  removed the CM enum value from the //// response property for the response status
- info
  removed the CN enum value from the //// response property for the response status
- info
  removed the CO enum value from the //// response property for the response status
- info
  removed the CR enum value from the //// response property for the response status
- info
  removed the CU enum value from the //// response property for the response status
- info
  removed the CV enum value from the //// response property for the response status
- info
  removed the CW enum value from the //// response property for the response status
- info
  removed the CX enum value from the //// response property for the response status
- info
  removed the CY enum value from the //// response property for the response status
- info
  removed the CZ 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 DE 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 DJ enum value from the //// response property for the response status
- info
  removed the DK enum value from the //// response property for the response status
- info
  removed the DM enum value from the //// response property for the response status
- info
  removed the DO enum value from the //// response property for the response status
- info
  removed the DZ enum value from the //// response property for the response status
- info
  removed the EC enum value from the //// response property for the response status
- info
  removed the EE enum value from the //// response property for the response status
- info
  removed the EG enum value from the //// response property for the response status
- info
  removed the EH enum value from the //// response property for the response status
- info
  removed the ER enum value from the //// response property for the response status
- info
  removed the ES enum value from the //// response property for the response status
- info
  removed the ET enum value from the //// response property for the response status
- info
  removed the FI enum value from the //// response property for the response status
- info
  removed the FJ enum value from the //// response property for the response status
- info
  removed the FK enum value from the //// response property for the response status
- info
  removed the FM enum value from the //// response property for the response status
- info
  removed the FO enum value from the //// response property for the response status
- info
  removed the FR enum value from the //// response property for the response status
- info
  removed the GA enum value from the //// response property for the response status
- info
  removed the GB enum value from the //// response property for the response status
- info
  removed the GD enum value from the //// response property for the response status
- info
  removed the GE enum value from the //// response property for the response status
- info
  removed the GF enum value from the //// response property for the response status
- info
  removed the GG enum value from the //// response property for the response status
- info
  removed the GH enum value from the //// response property for the response status
- info
  removed the GI enum value from the //// response property for the response status
- info
  removed the GL enum value from the //// response property for the response status
- info
  removed the GM enum value from the //// response property for the response status
- info
  removed the GN enum value from the //// response property for the response status
- info
  removed the GP enum value from the //// response property for the response status
- info
  removed the GQ enum value from the //// response property for the response status
- info
  removed the GR enum value from the //// response property for the response status
- info
  removed the GS enum value from the //// response property for the response status
- info
  removed the GT enum value from the //// response property for the response status
- info
  removed the GU enum value from the //// response property for the response status
- info
  removed the GW enum value from the //// response property for the response status
- info
  removed the GY enum value from the //// response property for the response status
- info
  removed the HK enum value from the //// response property for the response status
- info
  removed the HM enum value from the //// response property for the response status
- info
  removed the HN enum value from the //// response property for the response status
- info
  removed the HR enum value from the //// response property for the response status
- info
  removed the HT enum value from the //// response property for the response status
- info
  removed the HU enum value from the //// response property for the response status
- info
  removed the ID enum value from the //// response property for the response status
- info
  removed the IE enum value from the //// response property for the response status
- info
  removed the IL enum value from the //// response property for the response status
- info
  removed the IM enum value from the //// response property for the response status
- info
  removed the IN enum value from the //// response property for the response status
- info
  removed the IO enum value from the //// response property for the response status
- info
  removed the IQ enum value from the //// response property for the response status
- info
  removed the IR enum value from the //// response property for the response status
- info
  removed the IS enum value from the //// response property for the response status
- info
  removed the IT 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 JE enum value from the //// response property for the response status
- info
  removed the JM enum value from the //// response property for the response status
- info
  removed the JO enum value from the //// response property for the response status
- info
  removed the JP enum value from the //// response property for the response status
- info
  removed the KE enum value from the //// response property for the response status
- info
  removed the KG enum value from the //// response property for the response status
- info
  removed the KH enum value from the //// response property for the response status
- info
  removed the KI enum value from the //// response property for the response status
- info
  removed the KM enum value from the //// response property for the response status
- info
  removed the KN enum value from the //// response property for the response status
- info
  removed the KP enum value from the //// response property for the response status
- info
  removed the KR enum value from the //// response property for the response status
- info
  removed the KW enum value from the //// response property for the response status
- info
  removed the KY enum value from the //// response property for the response status
- info
  removed the KZ enum value from the //// response property for the response status
- info
  removed the LA enum value from the //// response property for the response status
- info
  removed the LB enum value from the //// response property for the response status
- info
  removed the LC enum value from the //// response property for the response status
- info
  removed the LI enum value from the //// response property for the response status
- info
  removed the LK enum value from the //// response property for the response status
- info
  removed the LR enum value from the //// response property for the response status
- info
  removed the LS enum value from the //// response property for the response status
- info
  removed the LT enum value from the //// response property for the response status
- info
  removed the LU enum value from the //// response property for the response status
- info
  removed the LV enum value from the //// response property for the response status
- info
  removed the LY enum value from the //// response property for the response status
- info
  removed the MA enum value from the //// response property for the response status
- info
  removed the MC enum value from the //// response property for the response status
- info
  removed the MD enum value from the //// response property for the response status
- info
  removed the ME enum value from the //// response property for the response status
- info
  removed the MF enum value from the //// response property for the response status
- info
  removed the MG enum value from the //// response property for the response status
- info
  removed the MH enum value from the //// response property for the response status
- info
  removed the MK enum value from the //// response property for the response status
- info
  removed the ML enum value from the //// response property for the response status
- info
  removed the MM enum value from the //// response property for the response status
- info
  removed the MN enum value from the //// response property for the response status
- info
  removed the MO enum value from the //// response property for the response status
- info
  removed the MP enum value from the //// response property for the response status
- info
  removed the MQ enum value from the //// response property for the response status
- info
  removed the MR enum value from the //// response property for the response status
- info
  removed the MS enum value from the //// response property for the response status
- info
  removed the MT enum value from the //// response property for the response status
- info
  removed the MU enum value from the //// response property for the response status
- info
  removed the MV enum value from the //// response property for the response status
- info
  removed the MW enum value from the //// response property for the response status
- info
  removed the MX enum value from the //// response property for the response status
- info
  removed the MY enum value from the //// response property for the response status
- info
  removed the MZ enum value from the //// response property for the response status
- info
  removed the NA enum value from the //// response property for the response status
- info
  removed the NC enum value from the //// response property for the response status
- info
  removed the NE enum value from the //// response property for the response status
- info
  removed the NF enum value from the //// response property for the response status
- info
  removed the NG enum value from the //// response property for the response status
- info
  removed the NI enum value from the //// response property for the response status
- info
  removed the NL enum value from the //// response property for the response status
- info
  removed the NO enum value from the //// response property for the response status
- info
  removed the NP enum value from the //// response property for the response status
- info
  removed the NR enum value from the //// response property for the response status
- info
  removed the NU enum value from the //// response property for the response status
- info
  removed the NZ enum value from the //// response property for the response status
- info
  removed the OM enum value from the //// response property for the response status
- info
  removed the PA enum value from the //// response property for the response status
- info
  removed the PE 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 PF enum value from the //// response property for the response status
- info
  removed the PG enum value from the //// response property for the response status
- info
  removed the PH enum value from the //// response property for the response status
- info
  removed the PK enum value from the //// response property for the response status
- info
  removed the PL enum value from the //// response property for the response status
- info
  removed the PM enum value from the //// response property for the response status
- info
  removed the PN enum value from the //// response property for the response status
- info
  removed the PR enum value from the //// response property for the response status
- info
  removed the PS enum value from the //// response property for the response status
- info
  removed the PT enum value from the //// response property for the response status
- info
  removed the PW enum value from the //// response property for the response status
- info
  removed the PY enum value from the //// response property for the response status
- info
  removed the QA enum value from the //// response property for the response status
- info
  removed the RE enum value from the //// response property for the response status
- info
  removed the RO enum value from the //// response property for the response status
- info
  removed the RS enum value from the //// response property for the response status
- info
  removed the RU enum value from the //// response property for the response status
- info
  removed the RW enum value from the //// response property for the response status
- info
  removed the SA enum value from the //// response property for the response status
- info
  removed the SB enum value from the //// response property for the response status
- info
  removed the SC enum value from the //// response property for the response status
- info
  removed the SD enum value from the //// response property for the response status
- info
  removed the SE enum value from the //// response property for the response status
- info
  removed the SG enum value from the //// response property for the response status
- info
  removed the SH enum value from the //// response property for the response status
- info
  removed the SI enum value from the //// response property for the response status
- info
  removed the SJ enum value from the //// response property for the response status
- info
  removed the SK enum value from the //// response property for the response status
- info
  removed the SL enum value from the //// response property for the response status
- info
  removed the SM enum value from the //// response property for the response status
- info
  removed the SN enum value from the //// response property for the response status
- info
  removed the SO enum value from the //// response property for the response status
- info
  removed the SR enum value from the //// response property for the response status
- info
  removed the SS enum value from the //// response property for the response status
- info
  removed the ST enum value from the //// response property for the response status
- info
  removed the SUBMITTED enum value from the response property for the response status
- info
  removed the SV enum value from the //// response property for the response status
- info
  removed the SX enum value from the //// response property for the response status
- info
  removed the SY enum value from the //// response property for the response status
- info
  removed the SZ enum value from the //// response property for the response status
- info
  removed the TC enum value from the //// response property for the response status
- info
  removed the TD enum value from the //// response property for the response status
- info
  removed the TF enum value from the //// response property for the response status
- info
  removed the TG enum value from the //// response property for the response status
- info
  removed the TH enum value from the //// response property for the response status
- info
  removed the TJ enum value from the //// response property for the response status
- info
  removed the TK enum value from the //// response property for the response status
- info
  removed the TL enum value from the //// response property for the response status
- info
  removed the TM enum value from the //// response property for the response status
- info
  removed the TN enum value from the //// response property for the response status
- info
  removed the TO enum value from the //// response property for the response status
- info
  removed the TR enum value from the //// response property for the response status
- info
  removed the TT enum value from the //// response property for the response status
- info
  removed the TV enum value from the //// response property for the response status
- info
  removed the TW enum value from the //// response property for the response status
- info
  removed the TZ enum value from the //// response property for the response status
- info
  removed the UA enum value from the //// response property for the response status
- info
  removed the UG enum value from the //// response property for the response status
- info
  removed the UM enum value from the //// response property for the response status
- info
  removed the US enum value from the //// response property for the response status
- info
  removed the UY enum value from the //// response property for the response status
- info
  removed the UZ enum value from the //// response property for the response status
- info
  removed the VA enum value from the //// response property for the response status
- info
  removed the VC enum value from the //// response property for the response status
- info
  removed the VE enum value from the //// response property for the response status
- info
  removed the VG enum value from the //// response property for the response status
- info
  removed the VI enum value from the //// response property for the response status
- info
  removed the VN enum value from the //// response property for the response status
- info
  removed the VU enum value from the //// response property for the response status
- info
  removed the WF enum value from the //// response property for the response status
- info
  removed the WS enum value from the //// response property for the response status
- info
  removed the YE enum value from the //// response property for the response status
- info
  removed the YT enum value from the //// response property for the response status
- info
  removed the ZA enum value from the //// response property for the response status
- info
  removed the ZM enum value from the //// response property for the response status
- info
  removed the ZW enum value from the //// response property for the response status

Operation history (12 revisions)