Fund an EUR account by open banking
Start an open banking payment that pulls euros from the customer’s own bank account into their EUR internal account. The customer approves the payment at their bank, so no card or bank details are entered in your app.
- Create the payment. It is
PENDINGand carries anauthorizationUrl. - Send the customer to
authorizationUrl. They choose their bank and approve the payment there. - The customer returns to your
redirectUrl, withopenBankingPaymentIdadded to its query. Returning does not mean the payment succeeded; show a “processing” state. - When the bank sends the funds, the payment becomes
COMPLETED, anOPEN_BANKING_PAYMENT.COMPLETEDwebhook is sent, and the funds credit the internal account as an incoming transaction. A cancelled or refused payment becomesFAILED, and one not approved beforeexpiresAtbecomesEXPIRED.
Available for individual customers’ EUR internal accounts, once
Lightspark has enabled open banking for your platform. Other accounts
return 400.
In sandbox, authorizationUrl opens a Grid page that simulates the bank.
Its button completes the payment and returns the customer to your
redirectUrl, as in production. You can also settle the payment directly
with POST /sandbox/open-banking-payments/{openBankingPaymentId}/complete.
Send an Idempotency-Key header to make retries safe: a request carrying
a key already used returns the payment created by the first request.
Authorizations
Headers
Body
The https page the customer returns to after leaving their bank. Grid adds an openBankingPaymentId query parameter naming this payment and keeps any query parameters already present. Reaching this page does not mean the payment succeeded: read the outcome from the OPEN_BANKING_PAYMENT webhook or GET the payment. Ignore any other query parameters added on the way back.
1024^https://"https://app.example.com/top-up/return"
Response
The Idempotency-Key was already used to create this payment. The payment created by the first request is returned.
Send the customer here to choose their bank and approve the payment. Open it in the customer's browser or a web view rather than an iframe, since many banks hand off to their own app to approve. In sandbox it opens a Grid page that simulates the bank.
"https://pay.example-provider.com/consent/7f3a9c1e"
The deadline for the customer to approve the payment, after which authorizationUrl stops working. A payment the customer has not approved by then becomes EXPIRED. One approved in time stays PENDING until the bank sends the funds or refuses them.
"2026-11-19T15:02:00Z"