Bank accounts & withdrawals

Two capabilities are involved and they are granted separately: bank manages payout destinations, and withdraw moves money. A token can hold one without the other.

List bank accounts

GET/partner/users/:user_code/bank-accountsbank

curl https://api.oropocket.com/partner/users/usr_xxx/bank-accounts \
  -H "Authorization: Bearer oro_live_xxx"

Returns the user's user_code plus a bank_accounts array. Each entry:

Field	Type	Description
id	number	Pass this as bank_account_id when creating a withdrawal.
accountHolderName	string	Name on the account, as submitted.
accountType	string	"savings" or "current".
accountNumber	string	MASKED account number — only the last 4 digits are visible. The full number is never returned.
ifscCode	string	IFSC code, upper-cased.
bankName	string	Resolved from the IFSC — you don't submit it.
branchName	string	Also resolved from the IFSC.
upiId	string \| null	UPI handle, when one was supplied.
isVerified	boolean	Whether the account has passed verification.
isPrimary	boolean	The user's default payout account.
status	string	Active/inactive state of the account record.
createdAt	string	ISO-8601 timestamp.

Account numbers are always masked on the Partner API. The full number is never returned, on any endpoint, in either mode — so don't design a UI that expects to echo it back.

Add a bank account

POST/partner/users/:user_code/bank-accountsbank

Submit the holder name, account type, account number and IFSC. The bank and branch are resolved from the IFSC for you. A UPI handle can be stored alongside.

Field	Type		Description
account_holder_name	string	required	Name on the bank account. At least 2 characters.
account_type	string	required	Either "savings" or "current".
account_number	string	required	8–20 digits.
ifsc_code	string	required	11-character IFSC in the form ABCD0123456 (4 letters, a zero, then 6 alphanumerics). bank_name and branch are auto-resolved from it.
upi_id	string	optional	Optional UPI handle, e.g. anya@okhdfcbank, stored alongside the account.

curl -X POST https://api.oropocket.com/partner/users/usr_xxx/bank-accounts \
  -H "Authorization: Bearer oro_live_xxx" \
  -d '{
    "account_holder_name": "Anya Sharma",
    "account_type": "savings",
    "account_number": "50100123456789",
    "ifsc_code": "HDFC0000123"
  }'

Response

{
  "success": true,
  "data": {
    "user_code": "usr_xxx",
    "bank_account": {
      "id": 4821,
      "accountHolderName": "Anya Sharma",
      "accountType": "savings",
      "accountNumber": "XXXXXX6789",
      "ifscCode": "HDFC0000123",
      "bankName": "HDFC Bank",
      "branchName": "Banjara Hills",
      "upiId": null,
      "isVerified": false,
      "isPrimary": true,
      "createdAt": "2026-08-08T09:22:00.000Z"
    }
  }
}

Create a withdrawal

POST/partner/users/:user_code/withdrawalswithdraw

Field	Type		Description
amount_inr	number	required	₹100 minimum, ₹5,00,000 maximum per transaction.
bank_account_id	number	required	The id of one of the user's registered bank accounts.

Withdrawals require approved KYC. If the user hasn't finished verification the call fails with 403 KYC_REQUIRED — run them through the KYC endpoints first. Buys, sells and receiving gifts have no such requirement.

curl -X POST https://api.oropocket.com/partner/users/usr_xxx/withdrawals \
  -H "Authorization: Bearer oro_live_xxx" \
  -H "Idempotency-Key: <uuid>" \
  -d '{"amount_inr": 2500, "bank_account_id": 4821}'

The response carries the user's code and a withdrawal object:

Field	Type	Description
transaction_id	string	Reference for this payout. Quote it in support requests and match it against webhooks.
amount_inr	number	Gross amount requested.
bank_account_id	number	Destination account.
status	string	Always "pending" at creation. It moves on asynchronously — listen on webhooks rather than polling.
created_at	string	ISO-8601 timestamp.

Withdrawals are validated against your sub-wallet claim, not the user's whole OroPocket balance. A user may hold plenty overall and still be rejected because only part of it came in through your integration — see Sub-wallets.

List withdrawals

GET/partner/users/:user_code/withdrawalswithdraw

Field	Type		Description
limit	number	optional	Page size. Defaults to 20, capped at 100.
offset	number	optional	Rows to skip. Defaults to 0.

Returns user_code and a withdrawals array, newest first, in the same shape as the create response.

curl "https://api.oropocket.com/partner/users/usr_xxx/withdrawals?limit=20&offset=0" \
  -H "Authorization: Bearer oro_live_xxx"

Sandbox behaviour

In sandbox the payout rail is simulated but the state machine is real. Any amount whose paise end in .01 deterministically fails and refunds the user's test INR balance — so 2500.01 exercises your failure path on demand. Every other amount starts pending and moves to completed shortly after. Sandbox KYC still has to be approved first, which the magic PAN and Aadhaar values make instant.

← KYC Wallet & ledger →