Fetch Payments Made Using Bank Transfer

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

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String paymentId = "pay_CmiztqmYJPtDAu";

Payment payment = instance.payments.fetchBankTransfers(paymentId)

$api = new Api($key_id, $secret);

$api->payment->fetch($virtualId)->bankTransfer();

require "razorpay"
Razorpay.setup('key_id', 'key_secret')

paymend_id = "pay_Di5iqCqA1WEHq6"

Razorpay::Payment.fetch(paymend_id).bank_transfer

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment.bank_transfer(paymentId)

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.bankTransfer(paymentId)

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.Payment.BankTransfer("<paymentID>", nil, nil)

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

paymend_id = "pay_Di5iqCqA1WEHq6"

Razorpay::Razorpay::Payment.fetch(paymend_id).bank_transfer

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]

string paymentId = "pay_Z6t7VFTb9xHeOs";

BankTransfer virtualaccount = client.Payment.Fetch(paymentId).BankTransfers();

razorpay smart-collect fetch-by-bank-transfer pay_DlGmm7jInLudH8

{
  "id": "bt_Di5iqCElVyRlCb",
  "entity": "bank_transfer",
  "payment_id": "pay_Di5iqCqA1WEHq6",
  "mode": "NEFT",
  "bank_reference": "157414364471",
  "amount": 239000,
  "payer_bank_account": {
    "id": "ba_Di5iqSxtYrTzPU",
    "entity": "bank_account",
    "ifsc": "UTIB0003198",
    "bank_name": "Axis Bank",
    "name": "Acme Corp",
    "notes": [],
    "account_number": "765432123456789"
  },
  "virtual_account_id": "va_Di5gbNptcWV8fQ",
  "virtual_account": {
    "id": "va_Di5gbNptcWV8fQ",
    "name": "Acme Corp",
    "entity": "virtual_account",
    "status": "closed",
    "description": "Customer Identifier created for M/S ABC Exports",
    "amount_expected": 2300,
    "notes": {
      "material": "teakwood"
    },
    "amount_paid": 239000,
    "customer_id": "cust_DOMUFFiGdCaCUJ",
    "receivers": [
      {
        "id": "ba_Di5gbQsGn0QSz3",
        "entity": "bank_account",
        "ifsc": "RATN0VAAPIS",
        "bank_name": "RBL Bank",
        "name": "Acme Corp",
        "notes": [],
        "account_number": "1112220061746877"
      }
    ],
    "close_by": 1574427237,
    "closed_at": 1574164078,
    "created_at": 1574143517
  }
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

GET

payments

:id

bank_transfer

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

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String paymentId = "pay_CmiztqmYJPtDAu";

Payment payment = instance.payments.fetchBankTransfers(paymentId)

$api = new Api($key_id, $secret);

$api->payment->fetch($virtualId)->bankTransfer();

require "razorpay"
Razorpay.setup('key_id', 'key_secret')

paymend_id = "pay_Di5iqCqA1WEHq6"

Razorpay::Payment.fetch(paymend_id).bank_transfer

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment.bank_transfer(paymentId)

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.bankTransfer(paymentId)

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.Payment.BankTransfer("<paymentID>", nil, nil)

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

paymend_id = "pay_Di5iqCqA1WEHq6"

Razorpay::Razorpay::Payment.fetch(paymend_id).bank_transfer

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]

string paymentId = "pay_Z6t7VFTb9xHeOs";

BankTransfer virtualaccount = client.Payment.Fetch(paymentId).BankTransfers();

razorpay smart-collect fetch-by-bank-transfer pay_DlGmm7jInLudH8

{
  "id": "bt_Di5iqCElVyRlCb",
  "entity": "bank_transfer",
  "payment_id": "pay_Di5iqCqA1WEHq6",
  "mode": "NEFT",
  "bank_reference": "157414364471",
  "amount": 239000,
  "payer_bank_account": {
    "id": "ba_Di5iqSxtYrTzPU",
    "entity": "bank_account",
    "ifsc": "UTIB0003198",
    "bank_name": "Axis Bank",
    "name": "Acme Corp",
    "notes": [],
    "account_number": "765432123456789"
  },
  "virtual_account_id": "va_Di5gbNptcWV8fQ",
  "virtual_account": {
    "id": "va_Di5gbNptcWV8fQ",
    "name": "Acme Corp",
    "entity": "virtual_account",
    "status": "closed",
    "description": "Customer Identifier created for M/S ABC Exports",
    "amount_expected": 2300,
    "notes": {
      "material": "teakwood"
    },
    "amount_paid": 239000,
    "customer_id": "cust_DOMUFFiGdCaCUJ",
    "receivers": [
      {
        "id": "ba_Di5gbQsGn0QSz3",
        "entity": "bank_account",
        "ifsc": "RATN0VAAPIS",
        "bank_name": "RBL Bank",
        "name": "Acme Corp",
        "notes": [],
        "account_number": "1112220061746877"
      }
    ],
    "close_by": 1574427237,
    "closed_at": 1574164078,
    "created_at": 1574143517
  }
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

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.

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

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String paymentId = "pay_CmiztqmYJPtDAu";

Payment payment = instance.payments.fetchBankTransfers(paymentId)

$api = new Api($key_id, $secret);

$api->payment->fetch($virtualId)->bankTransfer();

require "razorpay"
Razorpay.setup('key_id', 'key_secret')

paymend_id = "pay_Di5iqCqA1WEHq6"

Razorpay::Payment.fetch(paymend_id).bank_transfer

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.payment.bank_transfer(paymentId)

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.payments.bankTransfer(paymentId)

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.Payment.BankTransfer("<paymentID>", nil, nil)

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

paymend_id = "pay_Di5iqCqA1WEHq6"

Razorpay::Razorpay::Payment.fetch(paymend_id).bank_transfer

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]

string paymentId = "pay_Z6t7VFTb9xHeOs";

BankTransfer virtualaccount = client.Payment.Fetch(paymentId).BankTransfers();

razorpay smart-collect fetch-by-bank-transfer pay_DlGmm7jInLudH8

{
  "id": "bt_Di5iqCElVyRlCb",
  "entity": "bank_transfer",
  "payment_id": "pay_Di5iqCqA1WEHq6",
  "mode": "NEFT",
  "bank_reference": "157414364471",
  "amount": 239000,
  "payer_bank_account": {
    "id": "ba_Di5iqSxtYrTzPU",
    "entity": "bank_account",
    "ifsc": "UTIB0003198",
    "bank_name": "Axis Bank",
    "name": "Acme Corp",
    "notes": [],
    "account_number": "765432123456789"
  },
  "virtual_account_id": "va_Di5gbNptcWV8fQ",
  "virtual_account": {
    "id": "va_Di5gbNptcWV8fQ",
    "name": "Acme Corp",
    "entity": "virtual_account",
    "status": "closed",
    "description": "Customer Identifier created for M/S ABC Exports",
    "amount_expected": 2300,
    "notes": {
      "material": "teakwood"
    },
    "amount_paid": 239000,
    "customer_id": "cust_DOMUFFiGdCaCUJ",
    "receivers": [
      {
        "id": "ba_Di5gbQsGn0QSz3",
        "entity": "bank_account",
        "ifsc": "RATN0VAAPIS",
        "bank_name": "RBL Bank",
        "name": "Acme Corp",
        "notes": [],
        "account_number": "1112220061746877"
      }
    ],
    "close_by": 1574427237,
    "closed_at": 1574164078,
    "created_at": 1574143517
  }
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

Path Parameters

string

required

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

Response Parameters

string

The unique identifier of the bank transfer.

string

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

string

The unique identifier of the payment.

string

The mode of bank transfer used. Possible values are:

NEFT
RTGS
IMPS
UPI

string

Unique reference number provided by the bank for the transaction.

object

The payer bank account details from which payment is received.

string

The unique identifier of the customer’s bank account.

string

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

string

The IFSC associated with the bank account.

string

The name of the bank in which the customer has an account.

object

Any custom notes added to the Customer Identifier.

string

The unique account number of the customer.

string

The unique identifier of the Customer Identifier.

object

Details of the Customer Identifier.

string

The unique identifier of the Customer Identifier.

string

The merchant billing label as it appears on Dashboard.

string

The name of the entity. Here, it is virtual account.

string

Indicates the status of the Customer Identifier. Possible values are:

active
closed

string

A brief description about the Customer Identifier.

integer

The amount expected by the merchant.

integer

The amount paid by the customer to the Customer Identifier.

object

Any custom notes added during the creation of the Customer Identifier.

string

The unique identifier of the customer the Customer Identifier is linked with. Know more about Customers API.

object

Configuration of desired receivers for the Customer Identifier.

string

The unique identifier of the Customer Identifier. For example, ba_Di5gbQsGn0QSz3.

string

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

string

The IFSC for the Customer Identifier created. For example, RATN0VAAPIS.

string

The bank associated with the Customer Identifier. For example, RBL.

string

The unique account number provided by the bank. For example, 1112220061746877.

string

The merchant billing label as it appears on Dashboard.

object

Any custom notes added during the creation of the Customer Identifier.

integer

UNIX timestamp at which the Customer Identifier is scheduled to be automatically closed. The time must be at least 15 minutes after current time. The date range can be set till 2147483647 in UNIX timestamp format (equivalent to Tuesday, January 19, 2038 8:44:07 AM GMT+05:30). Any request beyond 2147483647 UNIX timestamp will fail.

integer

UNIX timestamp at which the Customer Identifier is automatically closed.

integer

UNIX timestamp at which the Customer Identifier was created.

Errors

The API `<key/secret> ` provided is invalid.

Code: 4xxOccurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.Solution: Make sure that the API keys are active and entered correctly. Also, make sure there are no whitespaces before or after the keys.

Partners

Payout APIs

Fetch Payments Made Using Bank Transfer

Path Parameters

Response Parameters

Errors

​Path Parameters

​Response Parameters

​Errors

Path Parameters

Response Parameters

Errors