> For the complete documentation index, see [llms.txt](https://doc.paysats.exchange/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.paysats.exchange/developers/payout-methods.md).

# Payout methods

Every off-ramp order settles into a **local bank account** or **e-wallet** in the market the order targets. Indonesia (IDR) is live today; India (INR) is next. Which rails are available depends on our redeem partner's coverage at request time, which is why you should **always call `GET /v1/payout/methods`** before creating an order.

## Shape

```ts
type PayoutMethod = {
  bankCode: string;
  bankName: string;
  maxAmountTransfer?: number | string | null;
  kind: "bank" | "ewallet";
};
```

* `bankCode`: opaque identifier. **Do not parse it.** For banks it's typically the local routing code (e.g. the 3-digit BI code `014` for BCA in Indonesia); for e-wallets it's a short slug (e.g. `gopay`).
* `bankName`: display name. Must be passed back as `idrxBankName` **exactly as given**.
* `maxAmountTransfer`: optional per-transaction cap in local fiat. When present, `idrAmount` must be ≤ this value.
* `kind`: `"bank"` or `"ewallet"`. Determines the `recipientDetails` format.

## Banks (`kind: "bank"`)

Local bank list for the target market, routed through the redeem partner operating in that market (IDRX for Indonesia, INR-pegged partners for India).

| Market           | Example banks (`bankCode`)                                                                                   |
| ---------------- | ------------------------------------------------------------------------------------------------------------ |
| Indonesia (live) | BCA (`014`), Mandiri (`008`), BRI (`002`), BNI (`009`), CIMB Niaga (`022`), Permata (`013`), Danamon (`011`) |
| India (next)     | HDFC, ICICI, SBI, Axis, Kotak, PNB (IFSC-based routing)                                                      |

{% hint style="info" %}
The table above is **illustrative**. The authoritative list is whatever `GET /v1/payout/methods` returns at the moment you make the call. New banks are added over time and individual codes can change.
{% endhint %}

`recipientDetails` for banks:

* **Digits only**, no spaces, dashes, or leading country codes.
* Typically 10–16 digits depending on the bank.

```ts
const order = await client.createOfframpOrder({
  idrAmount: 50_000,
  depositChannel: "lightning",
  idrxBankCode: "014",
  idrxBankName: "BCA",
  recipientDetails: "1234567890",
  bankAccountName: "Jane Doe",
});
```

## E-wallets (`kind: "ewallet"`)

Mobile-number-routed payouts.

| Market           | E-wallets (`bankCode`)                                                              |
| ---------------- | ----------------------------------------------------------------------------------- |
| Indonesia (live) | GoPay (`gopay`), OVO (`ovo`), DANA (`dana`), Jago (`jago`), ShopeePay (`shopeepay`) |
| India (next)     | Paytm, PhonePe, Google Pay (UPI VPA-based)                                          |

`recipientDetails` for e-wallets:

* E.164 format: `+628123456789` (Indonesia) or `+919123456789` (India)
* Or local format: `08123456789` (Indonesia) or `9123456789` (India)
* 10–15 digits total

```ts
const order = await client.createOfframpOrder({
  idrAmount: 50_000,
  depositChannel: "lightning",
  idrxBankCode: "gopay",
  idrxBankName: "GoPay",
  recipientDetails: "+628123456789",
});
```

{% hint style="warning" %}
The exact accepted format is validated server-side. If the server rejects, the `error` message tells you what to send (e.g. *"recipientDetails must be a valid local mobile number for e-wallet payouts"*).
{% endhint %}

## `bankAccountName`

* **Banks:** the legal holder name on the account. Optional: the server provides a default (`IDRX_DEFAULT_BANK_ACCOUNT_NAME` in the Indonesia flow) and a name normalisation step, but passing the real name improves payout routing and matching.
* **E-wallets:** usually ignored by the payout partner; safe to omit.

Either way, it's **redacted from server logs**.

## Picking a payout method programmatically

```ts
const methods = await client.listPayoutMethods();

const banks = methods.filter((m) => m.kind === "bank");
const ewallets = methods.filter((m) => m.kind === "ewallet");

// Ask the user to pick
const chosen = methods.find((m) => m.bankName === userSelection);
if (!chosen) throw new Error("Selected payout method is no longer available");

await client.createOfframpOrder({
  idrAmount: 50_000,
  depositChannel: "lightning",
  idrxBankCode: chosen.bankCode,
  idrxBankName: chosen.bankName,   // must match bankCode
  recipientDetails,
  bankAccountName,
});
```

{% hint style="danger" %}
**Never** build `idrxBankName` from a locally hard-coded lookup table. The pair `(bankCode, bankName)` is validated as a unit. Mismatches return HTTP 400.
{% endhint %}

## Fees

{% hint style="warning" %}
A fixed off-ramp fee applies when the payout target is a **bank account** or **e-wallet** (**Rp 5,000** in Indonesia today; INR equivalent at India launch). It's bundled into the quote returned at order creation. `idrAmount` is the amount the recipient receives.
{% endhint %}

## Limits

* `maxAmountTransfer` (when present on the `PayoutMethod`) is an **upper bound per transaction**.
* Additional daily / monthly caps may apply at the partner level; PaySats surfaces these as 400 errors at order creation time if you exceed them.

Next: [Deposit rails](/developers/deposit-rails.md) · [Order lifecycle](/developers/order-lifecycle.md) · [HTTP API /v1](/developers/http-api.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.paysats.exchange/developers/payout-methods.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.