v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB

Bank Account Verification

Query bank verification result

Retrieve the result of a previously created bank verification request.

For more information, see the documentation, and for sample calls, see the public Postman collection.

get/merchants/{merchantId}/banv/{bankVerificationId}/status

Path parameters

merchantIdstring required

A unique merchant ID provided by Peach Payments in hexadecimal format.

Example:d0bf5a6a909111f0aabf02d14af18cff

A unique merchant ID provided by Peach Payments.

bankVerificationIdstring required

A valid v4 UUID expressed in lowercase with dashes.

Example:6e029f3f-21bf-425d-8f65-4eef2b5d8bb2

The unique identifier for the bank verification request.

Response

Bank verification result

bankVerificationIdstring required

A valid v4 UUID expressed in lowercase with dashes.

createdstring date-time required

lastUpdatedstring date-time required

accountNumber'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

idNumber'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

initials'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

lastName'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

accountOpen'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

accountAcceptsCredits'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

accountAcceptsDebits'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

accountOpenGtThreeMonths'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

accountType'positive' | 'negative' | 'unverified' required

The per-field comparison result for a bank verification.

status'pending' | 'processing' | 'successful' | 'failed' required

The current status of the bank account verification request.

resultCodestring string required

The result code indicating the status or error of the payout.

Example response

{
  "bankVerificationId": "6e029f3f-21bf-425d-8f65-4eef2b5d8bb2",
  "created": "2024-03-14T22:00:00.000Z",
  "lastUpdated": "2024-03-14T22:10:00.000Z",
  "accountNumber": "positive",
  "idNumber": "positive",
  "initials": "unverified",
  "lastName": "positive",
  "accountOpen": "positive",
  "accountAcceptsCredits": "positive",
  "accountAcceptsDebits": "positive",
  "accountOpenGtThreeMonths": "positive",
  "accountType": "positive",
  "status": "successful",
  "resultCode": "2002.000.000"
}