API Test Keys

Fetch Payments Made By Bank Transfer

GET

/v1/payments/:id/bank_transfer

Click to copy

Use this endpoint to retrieve details of payments made using the bank transfer method.

If Razorpay does not receive the bank account information of the customer from the remitting bank, the payer_bank_account parameter will be set to null.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET \
3https://api.razorpay.com/v1/payments/pay_CmiztqmYJPtDAu/bank_transfer \

Success

Failure

1{
2  "id": "bt_Di5iqCElVyRlCb",
3  "entity": "bank_transfer",
4  "payment_id": "pay_Di5iqCqA1WEHq6",
5  "mode": "NEFT",
6  "bank_reference": "157414364471",
7  "amount": 239000,
8  "payer_bank_account": {
9    "id": "ba_Di5iqSxtYrTzPU",
10    "entity": "bank_account",
11    "ifsc": "UTIB0003198",
12    "bank_name": "Axis Bank",
13    "name": "Acme Corp",
14    "notes": [],
15    "account_number": "765432123456789"
16  },
17  "virtual_account_id": "va_Di5gbNptcWV8fQ",
18  "virtual_account": {
19    "id": "va_Di5gbNptcWV8fQ",
20    "name": "Acme Corp",
21    "entity": "virtual_account",
22    "status": "closed",
23    "description": "Customer Identifier created for M/S ABC Exports",
24    "amount_expected": 2300,
25    "notes": {
26      "material": "teakwood"
27    },
28    "amount_paid": 239000,
29    "customer_id": "cust_DOMUFFiGdCaCUJ",
30    "receivers": [
31      {
32        "id": "ba_Di5gbQsGn0QSz3",
33        "entity": "bank_account",
34        "ifsc": "RATN0VAAPIS",
35        "bank_name": "RBL Bank",
36        "name": "Acme Corp",
37        "notes": [],
38        "account_number": "1112220061746877"
39      }
40    ],
41    "close_by": 1574427237,
42    "closed_at": 1574164078,
43    "created_at": 1574143517
44  }
45}

Path Parameters

id

string

The unique identifier of the payment made to the Customer Identifier.

Response Parameters

id

string

The unique identifier of the bank transfer.

entity

string

The name of the entity. Here, it is bank_transfer.

payment_id

string

The unique identifier of the payment.

mode

string

The mode of bank transfer used. Possible values are:

NEFT
RTGS
IMPS
UPI

bank_reference

string

Unique reference number provided by the bank for the transaction.

payer_bank_account

object

The payer bank account details from which payment is received.

Show child parameters (6)

virtual_account_id

string

The unique identifier of the Customer Identifier.

virtual_account

object

Details of the Customer Identifier.

Show child parameters (13)

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

Solution

Fetch Payments Made By Bank Transfer

GET

/v1/payments/:id/bank_transfer

Click to copy

Use this endpoint to retrieve details of payments made using the bank transfer method.

If Razorpay does not receive the bank account information of the customer from the remitting bank, the payer_bank_account parameter will be set to null.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the payment made to the Customer Identifier.

Response Parameters

id

string

The unique identifier of the bank transfer.

entity

string

The name of the entity. Here, it is bank_transfer.

payment_id

string

The unique identifier of the payment.

mode

string

The mode of bank transfer used. Possible values are:

NEFT
RTGS
IMPS
UPI

bank_reference

string

Unique reference number provided by the bank for the transaction.

payer_bank_account

object

The payer bank account details from which payment is received.

Show child parameters (6)

virtual_account_id

string

The unique identifier of the Customer Identifier.

virtual_account

object

Details of the Customer Identifier.

Show child parameters (13)

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

Solution

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET \
3https://api.razorpay.com/v1/payments/pay_CmiztqmYJPtDAu/bank_transfer \

Success

Failure

1{
2  "id": "bt_Di5iqCElVyRlCb",
3  "entity": "bank_transfer",
4  "payment_id": "pay_Di5iqCqA1WEHq6",
5  "mode": "NEFT",
6  "bank_reference": "157414364471",
7  "amount": 239000,
8  "payer_bank_account": {
9    "id": "ba_Di5iqSxtYrTzPU",
10    "entity": "bank_account",
11    "ifsc": "UTIB0003198",
12    "bank_name": "Axis Bank",
13    "name": "Acme Corp",
14    "notes": [],
15    "account_number": "765432123456789"
16  },
17  "virtual_account_id": "va_Di5gbNptcWV8fQ",
18  "virtual_account": {
19    "id": "va_Di5gbNptcWV8fQ",
20    "name": "Acme Corp",
21    "entity": "virtual_account",
22    "status": "closed",
23    "description": "Customer Identifier created for M/S ABC Exports",
24    "amount_expected": 2300,
25    "notes": {
26      "material": "teakwood"
27    },
28    "amount_paid": 239000,
29    "customer_id": "cust_DOMUFFiGdCaCUJ",
30    "receivers": [
31      {
32        "id": "ba_Di5gbQsGn0QSz3",
33        "entity": "bank_account",
34        "ifsc": "RATN0VAAPIS",
35        "bank_name": "RBL Bank",
36        "name": "Acme Corp",
37        "notes": [],
38        "account_number": "1112220061746877"
39      }
40    ],
41    "close_by": 1574427237,
42    "closed_at": 1574164078,
43    "created_at": 1574143517
44  }
45}