payer_bank_account parameter will be set to null.
Request
Curl
Response
Success
Parameters
id mandatory
: string The unique identifier of the payment made to the Customer Identifier.
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:
NEFTRTGSIMPSUPI
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.
id
: string The unique identifier of the customer’s bank account.
entity
: string The name of the entity. Here, it is bank_account.
ifsc
: string The IFSC associated with the bank account.
bank_name
: string The name of the bank in which the customer has an account.
notes
: object Any custom notes added to the Customer Identifier.
account_number
: string The unique account number of the customer.
virtual_account_id
: string The unique identifier of the Customer Identifier.
virtual_account
: object Details of the Customer Identifier.
id
: string The unique identifier of the Customer Identifier.
name
: string The merchant billing label as it appears on Dashboard.
entity
: string The name of the entity. Here, it is virtual account.
status
: string Indicates the status of the Customer Identifier. Possible values are:
activeclosed
description
: string A brief description about the Customer Identifier.
amount_expected
: integer The amount expected by the merchant.
amount_paid
: integer The amount paid by the customer to the Customer Identifier.
notes
: object Any custom notes added during the creation of the Customer Identifier.
customer_id
: string The unique identifier of the customer the Customer Identifier is linked with. Know more about Customers API.
receivers
: object Configuration of desired receivers for the Customer Identifier.
id
: string The unique identifier of the Customer Identifier. For example, ba_Di5gbQsGn0QSz3.
entity
: string The name of the entity. Here, it is bank_account.
ifsc
: string The IFSC for the Customer Identifier created. For example, RATN0VAAPIS.
bank_name
: string The bank associated with the Customer Identifier. For example, RBL.
account_number
: string The unique account number provided by the bank. For example, 1112220061746877.
name
: string The merchant billing label as it appears on Dashboard.
notes
: object Any custom notes added during the creation of the Customer Identifier.
close_by
: 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.
closed_at
: integer UNIX timestamp at which the Customer Identifier is automatically closed.
created_at
: integer UNIX timestamp at which the Customer Identifier was created.
Errors
The API “ provided is invalid.- code: 4xx
- description: Occurs 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.