API v1

Build with the BankMe APIs

Send money from your BankMe wallet to any bank account (IMPS or NEFT) or UPI ID with one HTTPS call, and get a signed webhook when the payout settles.

What you can build

All of them share the same authentication, the same sandbox and the same wallet. Test everything in the sandbox first.

How it works

1. BankMe issues you a sandbox key (pk_... and sk_...). Production keys follow after your integration is approved.
2. Your server calls Create payout with a unique referenceId.
3. BankMe debits your wallet and sends the money. The result comes back in the response or as a webhook.
4. If a call times out, ask for the result with Payout status. Never retry with a new reference.

API access is issued by BankMe. Each key is tied to one wallet and one payout route, with its own per-payout and per-day limits. Contact your BankMe account manager to get your keys.

Writes money

Create payout

Send money to a bank account or UPI ID.

Request body

Beneficiary: bank account

Beneficiary: UPI

Response

Standard and instant payouts

Payout status

Fetch a payout by your own reference, plus the delivery state of its webhook.

Use this when a request timed out and you do not know if it arrived, or when you want to confirm a payout without waiting for the webhook. The webhook object shows status, attempts and lastError for the delivery of this payout's result.

Wallet balance

The current balance of the wallet your key pays from, in rupees.

Check it before large batches. In the sandbox the balance is virtual and is never debited.

Your IP address

Returns the public IP address BankMe sees for your request. No keys needed.

Run it from your production server, then give that address to BankMe to add to your allowlist.

Collects money

Create a payment

Collect a UPI payment from your customer through a BankMe payment link.

You create an order, then send your customer to the paymentUrl in the response. The customer pays on a BankMe hosted page. BankMe confirms the payment on its own side and tells you the result by webhook. You never handle the customer's UPI details.

Request body

Response

Example request

{
  "referenceId": "ORDER_10045",
  "amount": 499,
  "customer": { "name": "Asha K", "mobile": "9876543210" },
  "redirectUrl": "https://yourshop.example/thanks",
  "note": "Order 10045"
}

Errors

Payment status

Fetch an order by your own reference.

For an open live order, BankMe checks the latest result before it answers. Use this when a request timed out, when a webhook has not arrived, or when you want to confirm a payment yourself. An unknown reference returns NOT_FOUND.

Pay-in webhooks

BankMe tells your server when a payment succeeds or fails.

The body is JSON: an event field plus the same fields as the order response. The headers are x-bankme-event, x-bankme-timestamp and x-bankme-signature. The signature is HMAC-SHA256 of timestamp + "." + body, using your webhook secret, in hex. The header value is sha256= followed by that hex. It is the same scheme as your payout webhooks, so use the same verification code from the Webhooks section.

Settlement and activation

When you are paid

Money from your customer reaches BankMe first. Your wallet is credited with the netAmount only after BankMe has received it. Depending on how the payment was received, that is either instant or the next working day (T+1). Your settlementStatus follows it: pending, then settled.

Pay-in money always settles to your BankMe wallet. Payouts to your own bank account use the Payout API, to verified accounts only.

Chargebacks

If a customer disputes a payment, the amount is debited from your wallet and the order shows a chargeback. If the wallet is short, the shortfall is kept as a balance due and recovered from your next credits. You can see chargebacks and a daily reconciliation in your Partner Console.

Going live

Test pay-in in the sandbox

No real money moves in the sandbox.

Create an order with your sandbox key. The paymentUrl opens a test page with two buttons, one to simulate a successful payment and one to simulate a failed payment. Press one, then read the result with the status call or your webhook.

Charged per found record

Verify a document

One call to check a PAN, GSTIN, bank account, company, licence and more. The product id goes in the path.

Send the inputs for that product in the JSON body. The product list shows the product ids and the inputs each one needs.

Request body

Response

Test in the sandbox

Bill categories

List the bill categories you can pay: electricity, water, gas, DTH, broadband and more.

Billers (operators)

List the billers in a category. Use the operatorCode when you fetch or pay a bill.

Query

Fetch a bill

Look up the amount due for a customer account before you pay.

Query

Test in the sandbox

Writes money

Pay a bill

Pay a bill from your wallet.

Request body

Response

Test in the sandbox

Bill payment status

Fetch a bill payment by your own reference.

Check a sender

Check whether a customer (the sender) is already registered for money transfer.

Limits and fees

Request body

Test in the sandbox

Register a sender

Register a new sender before their first transfer.

Request body

List recipients

List the recipients already saved for a sender.

Query

Add a recipient

Save a bank account as a recipient for a sender.

Request body

Send the transfer OTP

Send the confirmation OTP to the sender's mobile for one transfer.

Request body

Response

Writes money

Transfer money

Send money to the recipient's bank account.

Request body

Response

Test in the sandbox

Transfer status

Fetch a transfer by your own reference.

Balance enquiry

Check a customer's bank balance with their Aadhaar and fingerprint.

Request body

Test in the sandbox

Mini statement

Get the last few transactions of the customer's account.

Request body

Same fields as Balance enquiry.

Withdrawal OTP

Request the OTP for a cash withdrawal above Rs 5,000.

Request body

Writes money

Cash withdrawal

Pay cash to the customer against their Aadhaar and fingerprint.

Request body

Test in the sandbox

Webhooks

BankMe posts the result of each payout to the HTTPS URL registered for your key. Use it instead of polling.

Events

Headers on every delivery

Delivery rules

• Reply with any 2xx status within a few seconds to acknowledge. Anything else counts as a failure.
• Failed deliveries are retried automatically, so you can receive the same event more than once. Make your handler idempotent by looking up the payout by referenceId.
• The webhook URL must be https and use a public domain name. IP addresses, localhost and private networks are rejected.
• If your firewall limits inbound traffic, allow BankMe's outbound ranges: 74.220.52.0/24 and 74.220.60.0/24.
• A lost webhook never loses the result. Fetch it any time with Payout status.

Verify a webhook

Always check the signature before you trust a delivery.

1. Read the raw request body as received. Do not parse and re-encode it first.
2. Build the string timestamp + "." + rawBody.
3. Compute HMAC-SHA256 of it with your whsec_ secret and compare with x-bankme-signature in constant time.
4. Reject deliveries whose timestamp is more than 5 minutes old.
5. Process the event, then reply 200.

Send a test webhook

Sends a signed webhook.test delivery to your registered URL so you can check your handler end to end.

Works in the sandbox and in production. Your endpoint should verify the signature and reply 200 exactly as for a real event.