Mock Bank Verification

{ "status": true, "message": "Success", "data": { "id": "4e6f1b20-a73c-11ec-b909-0242ac120002", "customer_id": "550e8400-e29b-41d4-a716-446655440000", "country": "IND", "bank_account_type": "ACCOUNT_DETAILS", "identifiers": { "account_number": "7627389201", "ifsc": "SBIN0001829" }, "bank_account_status": "VERIFIED", "beneficiary_name": "JOHN DOE", "bank_name": "State Bank of India", "failure_reason": null } }

Error Codes and Messages

API Status Code	Response	Reason
400	Customer not found or access denied	Customer not found, or not in your organization
400	Bank account not found or access denied	Bank account not found, or not linked to this customer
400	Failure reason is required when bank status is FAILED	`bank_status` is `FAILED` without `failure_reason`
400	Mock bank verification is only allowed in non-production environment.	Called in production
500	Internal Server Error	Internal Server Error

Authorizations

X-API-KEY

string

header

required

API Key for authentication

X-TIMESTAMP

string

header

required

Current timestamp in seconds since epoch

X-SIGNATURE

string

header

required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json

customer_id

string<uuid>

required

Zapyd customer ID (UUID) returned by Create Customer.

Example:

"c2cf861b-342b-4318-a90e-85cd0312e82f"

bank_status

enum<string>

required

Result to set

Available options:

VERIFIED,

FAILED,

MANUAL_REVIEW

Example:

"VERIFIED"

bank_id

string<uuid>

Required except for US customers. Bank account ID returned by Add Bank Account. For a US customer, leave it out to create a linked sandbox account, which then appears in Fetch Bank Accounts.

Example:

"cab47575-bbcb-4294-81a3-30774104f3b6"

failure_reason

enum<string>

Required when bank_status is FAILED. Use a real reason so your error handling gets tested.

Available options:

INVALID_IFSC,

INVALID_ACCOUNT_NUMBER,

ACCOUNT_TYPE_NRE,

PENNY_DROP_FAILED,

NAME_MISMATCH,

BANK_RISK_CHECK_FAILED

Example:

"NAME_MISMATCH"

Response

Bank account status updated

status

boolean

Example:

true

message

string

Example:

"Success"

data

object

Hide child attributes

data.id

string<uuid>

Bank account ID

Example:

"4e6f1b20-a73c-11ec-b909-0242ac120002"

data.customer_id

string<uuid>

Customer ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.country

string

Customer country (alpha-3)

Example:

"IND"

data.bank_account_type

enum<string>

Payment rail

Available options:

ACCOUNT_DETAILS,

UPI

Example:

"ACCOUNT_DETAILS"

data.identifiers

object

Rail-specific identifiers. ACCOUNT_DETAILS: account_number and ifsc. UPI: vpa.

Example:

{
  "account_number": "7627389201",
  "ifsc": "SBIN0001829"
}

data.bank_account_status

enum<string>

Verification status

Available options:

PROCESSING,

VERIFIED,

FAILED,

MANUAL_REVIEW

Example:

"VERIFIED"

data.beneficiary_name

string

Account holder name returned by bank verification

Example:

"JOHN DOE"

data.bank_name

string

Bank name

Example:

"State Bank of India"

data.failure_reason

string | null

Set when bank_account_status is FAILED

Example:

null

Using the API

Onboarding

Money movement

Platform

Sandbox

Mock Bank Verification

Error Codes and Messages

Authorizations

Body

Response

​Error Codes and Messages

Authorizations

Body

Response

Error Codes and Messages