Pay by bank

Pay by bank is a payment link that only accepts a US bank account (ACH Direct Debit), in US dollars. Your backend creates it and shares checkout_url with the customer.

With bank details — send the customer’s routing and account number. The link opens with that account ready; the customer reviews the debit authorization and clicks Pay.
Without bank details — the customer picks their bank on the page (instant bank login) or types the account in.

Pay by bank must be enabled for your account by ParuPay — ask support@parupay.com. It works with sk_test_ (ParuPay sandbox, no real bank) and sk_live_.

Create

POST /v1/pay_by_bank with Authorization: Bearer sk_live_….

{
  "amount": 25000,
  "currency": "usd",
  "title": "Invoice 1042",
  "description": "Annual plan",
  "customer_name": "Jane Doe",
  "customer_email": "jane@example.com",
  "customer_phone": "+12025550123",
  "bank": {
    "routing_number": "110000000",
    "account_number": "000123456789",
    "account_holder_type": "individual",
    "account_type": "checking"
  },
  "billing_address": {
    "line1": "1 Main Street",
    "city": "Austin",
    "state": "TX",
    "postal_code": "73301",
    "country": "US"
  },
  "metadata": {
    "order_id": "1042",
    "return_url": "https://shop.example/orders/1042",
    "cancel_url": "https://shop.example/cart"
  }
}

Field	Required	Notes
`amount`	Yes	Cents, greater than 0. 25000 is 250.00 USD.
`currency`	No	Always `usd` — pay by bank is for US bank accounts only.
`title`	Yes	Shown on the pay page.
`description`	No	Shown under the title.
`customer_id`	No	A customer from your Customers list (`cus_…`). Their name, email and phone are used.
`customer_name`	Yes, unless `customer_id`	Account holder’s name, used for the bank debit.
`customer_email`	Yes, unless `customer_id`	Payment updates go to this address.
`customer_phone`	No	Stored on the link.
`bank`	No	The customer’s US bank account. Leave it out to let the customer choose their bank on the page.
`bank.routing_number`	With `bank`	9 digits.
`bank.account_number`	With `bank`	4 to 17 digits.
`bank.account_holder_type`	No	`individual` (default) or `company`.
`bank.account_type`	No	`checking` (default) or `savings`.
`billing_address`	No	The account holder’s US address: `line1`, `city`, `state` (e.g. `TX`) required; `line2`, `postal_code` optional; `country` is always `US`. If you leave it out, the pay page asks the customer for it.
`metadata`	No	Same rules as Pay by link: your `order_id`, `return_url`, `cancel_url`.

ParuPay keeps only the bank name and the last 4 digits of the account. The full numbers are never stored or returned.

Response

{
  "id": "plink_…",
  "url_slug": "…",
  "checkout_url": "https://pay.parupay.com/pay/…",
  "bank": { "bank_name": "STRIPE TEST BANK", "last4": "6789", "account_type": "checking" },
  "amount": 25000,
  "currency": "usd"
}

Field	Use it for
`id`	Link id, prefixed `plink_`. Store it on your order.
`checkout_url`	Share this with the customer, or redirect them to it.
`bank`	The saved account (bank name, last 4). `null` when you did not send `bank`.
`amount`, `currency`	What the customer’s bank is debited, in USD.

What the customer sees

The pay page shows the amount, the bank account (for example STRIPE TEST BANK •••• 6789) and the debit authorization. If you did not send billing_address, it also asks for the customer’s address.
The customer clicks Pay. The payment is now Processing — bank payments take up to 4 business days.
If the account was typed in (not logged in through the bank), the bank may first need to be verified with two small deposits. The page shows Verify bank account; the payment continues once the customer confirms the amounts.

Statuses

Status	Meaning
`processing`	The customer clicked Pay; the bank debit is on its way (up to 4 business days).
`requires_action`	The bank account must be verified with two small deposits first.
`succeeded`	The money arrived.
`requires_payment_method` with `last_payment_error`	The debit failed — for example insufficient funds or a closed account. The link can be paid again.

You receive the usual webhooks when a payment succeeds or fails.

Read

Request	What it does
`GET /v1/pay_by_bank/links`	Your pay by bank links, newest first.
`GET /v1/pay_by_bank/payments`	Pay by bank payment history: customer, bank, amount, status, failure reason.
`PATCH /v1/payment_links/:id`	Pause (`{"active": false}`) or resume a link.

Testing

With sk_test_ the ParuPay sandbox processes the payment — no real bank, no small deposits. After the customer clicks Pay the payment is processing, then about 10 seconds later succeeded or failed. Use routing number 110000000 with:

Account number	Result
`000123456789`	Succeeds
`000111111116`	Fails (insufficient funds)
`000111111113`	Fails (account closed)
`000222222227`	Fails (debit not authorized)

Any other account number succeeds.

Start

Accept payments

Developers

Create

Response

What the customer sees

Statuses

Read

Testing