Bank Operations API Documentation

This document explains how to complete the following tasks:

Add and verify bank account details for users.
Retrieve existing bank account information for specific users.
Understand the status of bank account verification.

Required Roles

To perform bank operations, your client account must be in an active state. All API calls require a valid access_token passed in the Authorization header.

Bank Account Management

This section provides details on how to manage bank accounts for users, especially for off-ramp transactions.

Add and Verify Bank Account

Description: Adds and verifies bank account details for a user. This process often includes a penny-drop verification to confirm account validity.

Request Body Payload

Property Name	Type	Mandatory	Length/Limit	Description
`user_id`	`string`	Yes	UUID	The unique ID of the user for whom the bank account is being added.
`account_number`	`string`	Yes	-	The user’s bank account number.
`ifsc_code`	`string`	Yes	11 characters	The IFSC code of the bank branch.

cURL Command

curl --request POST \
  --url https://api.swiftramp.in/v1/bank \
  --header 'Authorization: Bearer [ACCESS_TOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "46c7dc1e-c229-4f9f-83d6-d64851bedde7",
  "account_number": "3090262***",
  "ifsc_code": "RATN*****"
}'

Response Payload

Property Name	Type	Description
`status`	`boolean`	Indicates if the bank account processing was successful.
`code`	`integer`	HTTP status code (201 Created).
`message`	`string`	Human-readable response message.
`data`	`object`	Contains the details of the processed bank account, including verification status.

Retrieve Bank Account Information

Description: Retrieves bank account information for a specific user using their user_id.

cURL Command

curl --request GET \
  --url https://api.swiftramp.in/v1/bank/[USER_ID] \
  --header 'Authorization: Bearer [ACCESS_TOKEN]'

Success Response (200 OK)

{
  "status": true,
  "code": 200,
  "message": "Bank data retrieved successfully!",
  "data": [
    {
      "bank_id": "178621e1-ac93-48dc-9f07-b55b2d5b7746",
      "user_id": "e6ee0af8-c1e2-471f-9a51-fb26bd7621c8",
      "bank_name": null,
      "account_number": "664835******",
      "ifsc_code": "KKBK****",
      "bank_status": "success",
      "created_at": "2025-07-07T07:19:40.790Z",
      "updated_at": "2025-07-07T07:19:45.145Z"
    }
  ]
}

Enums and Constants

Bank Status

Value	Description
`success`	Bank account successfully added and verified.
`pending`	Bank account verification is in progress.
`failed`	Bank account verification failed.

💡 Ensure the user_id provided in the request body for POST /bank corresponds to an existing user.
💡 The bank_status field in the response indicates the current verification state of the bank account.
💡 For Indian users, adding a bank account is often a mandatory step after KYC for off-ramp transactions.

KYC Webhook