API Reference
Open Banking
Open banking lets a payer fund an account straight from their own bank, without typing in bank details.
- Create a transaction with the amount and the payer's name and email.
- Send the payer to the returned
url. They choose their bank and authorise the payment there. - The payer is redirected to your
redirect_url, and the transaction status updates as the bank confirms the payment.
POST
/accounts/{account_id}/bank_accounts/{bank_account_id}/open_banking_transactionCreates a pay-by-bank request into this bank account and returns the url to send the
payer to. They choose their bank, authorise the payment, and are redirected to your
redirect_url.
Authorization
BearerAuth AuthorizationBearer <token>
Token from POST /sign_in, sent as Authorization: Bearer <token>.
In: header
Path Parameters
account_id*string
ID of the account.
Format
uuidbank_account_id*string
ID of the bank account.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/accounts/8f3a2c1e-5b7d-4e9a-9c21-7d4b6e0f1a23/bank_accounts/6d1c9e2a-3f4b-4c8d-a7e6-5b2f0e9d1c47/open_banking_transaction" \ -H "Content-Type: application/json" \ -d '{ "amount": 49.9, "recipient": "Jane Doe", "email": "jane.doe@example.com", "description": "INV-0142", "redirect_url": "https://shop.example.com/checkout/complete" }'{ "data": { "id": "45443fe3-2cef-4ff1-aac2-c0b2bd68a593", "description": "INV-0142", "recipient": "Jane Doe", "amount": "49.90", "currency": "EUR", "status": "pending", "redirect_url": "https://shop.example.com/checkout/complete", "url": "https://pay.example-provider.com/s/45443fe3", "created_at": 1742210159 }}