---
title: "Query Batch Status"
method: GET
path: "/v3/payees/batch/{batchId}"
tags: ["Payee Invitation"]
---

# Query Batch Status

`GET /v3/payees/batch/{batchId}`

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

## Path parameters

- `batchId` string, uuid, required

## Response `200`

Get Batch Status

- QueryBatchResponse2
  - `status` 'SUBMITTED' | 'ACCEPTED' — Batch Status
  - `failureCount` integer
  - `pendingCount` integer
  - `failures` FailedSubmission2[]
    - `failedSubmission` Payee2
      - `type` 'Individual' | 'Company'
      - `payeeId` string, uuid
      - `payorRefs` PayeePayorRefV2[], nullable
        - `payorId` string, uuid
        - `remoteId` string
        - `invitationStatus` 'ACCEPTED' | 'PENDING' | 'DECLINED'
        - `invitationStatusTimestamp` string, date-time, nullable — The timestamp when the invitation status is updated
        - `paymentChannelId` string, uuid
      - `email` string, email, nullable
      - `address` PayeeAddress
        - `line1` string, required
        - `line2` string, nullable
        - `line3` string, nullable
        - `line4` string, nullable
        - `city` string, required
        - `countyOrProvince` string, nullable
        - `zipOrPostcode` string, nullable
        - `country` string, required
      - `country` string
      - `displayName` string
      - `paymentChannel` PayeePaymentChannel2
        - `paymentChannelName` string
        - `iban` string — Must match the regular expression ```^[A-Za-z0-9]+$```.
        - `accountNumber` string, required
        - `routingNumber` string, required
        - `countryCode` string, required — Country Code must be a valid 2 letter ISO 3166-1 country code
        - `currency` 'USD' | 'GBP' | 'EUR', required
        - `accountName` string, required
      - `challenge` Challenge
        - `value` string, required
        - `description` string, required
      - `language` 'AR' | 'EN' | 'ES' | 'FR' | 'HE' | 'HI' | 'JA' | 'PT' | 'RU' | 'UR' | 'ZH' — Available Payee Language codes
      - `acceptTermsAndConditionsTimestamp` string, date-time, nullable — The timestamp when the payee last accepted T&Cs
      - `cellphoneNumber` string
      - `payeeType` 'Individual' | 'Company'
      - `company` CompanyV1, nullable
        - `name` string, required
        - `taxId` string, nullable — Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\d]{9}```.
        - `operatingName` string, nullable
      - `individual` IndividualV1
        - `name` IndividualV1Name, required
          - `title` string
          - `firstName` string, required
          - `otherNames` string
          - `lastName` string, required
        - `nationalIdentification` string — If not authorized to view, value will be masked. Example: XXXXX1234
        - `dateOfBirth` string, required — If not authorized to view, value will be masked. Example: - XXXX-XX-XX
      - `created` string, date-time
      - `gracePeriodEndDate` string, date, nullable
      - `watchlistStatusUpdatedTimestamp` string, date_time, nullable
      - `marketingOptIns` MarketingOptIn[]
        - `optedIn` boolean
        - `timestamp` string, date-time
      - `onboardedStatus` 'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'
      - `remoteId` string — Remote Id must be between 1 and 100 characters long
    - `failureMessage` string

## Other responses

- `400` — Invalid request. See Error message payload for details of failure
- `401` — Invalid access token. May be expired or invalid
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions
- `404` — Resource not found

## Changes

- **2020-01-28** `1b2abf26b5d6` — 2 breaking, 5 warning, 12 info
  - the `failures/items/failedSubmission/paymentChannel/countryCode` response property's minLength was decreased from `9` to `2` for the response status `200`
  - removed the required property `failures/items/failedSubmission/paymentChannel/routingNo` from the response with the `200` status
  - removed the optional property `failures/items/failedSubmission/lastOfacCheckTimestamp` from the response with the `200` status
  - removed the optional property `failures/items/failedSubmission/ofacStatus` from the response with the `200` status
  - …15 more
- **2019-11-25** `86699f3efd3a` — 1 info
  - endpoint added
- **2019-07-15** `ced8e167a97c` — 1 info
  - api path removed with deprecation

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v3/payees/batch/:batchId/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/1b2abf26b5d6?raw)