Pay by bank
Pay by bank takes one payment for a set amount. You open a collection for that amount, send your payer the checkout_url we return, and they pay inside their own bank. When the payment settles, the amount lands in your GBP or EUR wallet and we send you a wallet_funded webhook.
In the API this is the collections endpoint, POST /v1/collections.
Available in GBP and EUR. There is no standing account: each collection is for one payment.
Before you start
- The API key needs the Create collections capability. A key without it gets
403 forbidden_collection_create. - You need a wallet in the currency you collect.
- Send an
Idempotency-Key. A retry with the same key returns the same collection and the samecheckout_url. - The amount must be worth more than it costs to collect. A smaller amount returns
422 amount_below_minimum. See Minimum amount.
Lifecycle
Only settled means money reached you. processing and pending_settlement mean the payer has authorised the payment, not that it has arrived, and a payment can still fail after authorisation. Release goods or credit a customer on settled only. Reconcile on settled_amount_minor, which can differ from the amount you asked for.
You do not need to poll. A settled collection fires the same wallet_funded webhook a bank account credit does, so if you already handle wallet funding, settlement is already wired.
Next
- Pay by bank (collections) API reference: create, retrieve and list collections, every status and error