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

# Query Batch Status

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

> **Deprecated.**

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

## Path parameters

- `batchId` string, uuid, required

## Response `200`

Get Batch Status

- QueryBatchResponseV3
  - `status` string — Batch Status. One of the following values: SUBMITTED, ACCEPTED
  - `failureCount` integer
  - `pendingCount` integer
  - `failures` FailedSubmissionV3[]
    - `failedSubmission` FailedPayeeV3
      - `payeeId` string, uuid
      - `payorRefs` PayeePayorRefV3[], nullable
        - `payorId` string, uuid
        - `remoteId` string
        - `invitationStatus` string
        - `invitationStatusTimestamp` string, date-time, nullable — The timestamp when the invitation status is updated
        - `paymentChannelId` string, uuid
        - `payableStatus` boolean — Indicates if the payee is payable for this payor
        - `payableIssues` PayableIssueV3[] — Indicates any conditions which prevent the payee from being payable for this payor
          - `code` string, required
          - `message` string, required
      - `email` string, email
      - `remoteId` string
      - `type` string — Type of Payee. One of the following values: Individual, Company
      - `address` CreatePayeeAddressV3
        - `line1` string, required
        - `line2` string, nullable
        - `line3` string, nullable
        - `line4` string, nullable
        - `city` string, required
        - `countyOrProvince` string, nullable
        - `zipOrPostcode` string, nullable
        - `country` string, required — 2 letter ISO 3166-1 country code
      - `paymentChannel` CreatePaymentChannelV3
        - `paymentChannelName` string
        - `iban` string — Must match the regular expression ```^[A-Za-z0-9]+$```.
        - `accountNumber` string — Either routing number and account number or only iban must be set
        - `routingNumber` string — Either routing number and account number or only iban must be set
        - `countryCode` string, required — Valid ISO 3166 2 character country code. See the <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" a>ISO specification</a> for details.
        - `currency` string, required — Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.
        - `accountName` string, required
      - `challenge` ChallengeV3
        - `value` string, required
        - `description` string, required
      - `language` string — An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.
      - `company` CompanyV3, nullable
        - `name` string, required
        - `taxId` string, nullable — Company Tax Id must be between 6 and 30 characters long
        - `operatingName` string, nullable
      - `individual` CreateIndividualV3
        - `name` CreateIndividualV3Name, required
          - `title` string
          - `firstName` string, required
          - `otherNames` string
          - `lastName` string, required
        - `nationalIdentification` string
        - `dateOfBirth` string, date, required — Must not be date in future. Example - 1970-05-20
    - `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` — The resource was not found or is no longer available

---

[API](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.net/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/05c3f09fc50a/schema)