Openbanking payments
Openbanking payments are payments where an consumer or business authorises a SEPA Sct or SEPA SCT Inst payment using the banks web portal. In the end, it is up to the
Steps to creating an openbanking single payment:
Create a payment request with the Paymentsendpoint.
Redirect the user to the link specific in the
next.redirectfield.When the user authorised the payment, the payment method
statewill change fromcreatedtosucceeded.When the user rejected the authorisation, the payment method
statewill change fromcreatedtofailed.You can skip our bank selection menu by suppling the following fields:
openbanking.countryopenbanking.bicuser.user_agentuser.acceptuser.accept_encodinguser.accept_languageuser.ip_addressuser.language
Note that in order for the deep links to work on mobile, the redirect link must be opened by an sync user interaction (i.e. button click).
If no execution date has been requested, the payment will be executed by the issuing bank as soon as possible, usually within 1-20 seconds.
When the execution has been started, but is not guaranteed, we change the
statefromcreatedtoprocessing(and call your webhook).When the execution has been been guaranteed, we change the
statefromcreated, orprocessing, tosucceeded.
Example payment creation
POST /v1/profiles/profile_c4f5e275fed234c98b38f90231/payments
Content-Type: application/json
Accept: application/json
Authorization: Bearer <your_access_token>
{
"description": "Test description",
"reference": "c75279b8-60f9-4a7d-a79a-3a231e967e24",
"method": "openbanking",
"currency": "EUR",
"amount": 2283,
"session": {
"redirect_url": "https://www.bankingservice.ai/payment-result"
}
}Example response:
{
"id": "payment_e04fd81843b943c58ef2fb8db9e66b2eec3",
"method": "openbanking",
"currency": "EUR",
"amount": 2283,
"openbanking": {
"method": "sepa"
},
"description": "Test description",
"state": "created",
"next": {
"redirect": "https://dashboard.bankingservice.ai/payment/payment_e04fd81843b943c58ef2fb8db9e66b2eec3/openbanking?reference=46c6255091e7a13cx7a6af81d0c4f7fe"
},
"metadata": null,
"created": "2023-19-12T08:30:35.758Z",
"_links": {
"self": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231/payments/payment_e04fd81843b943c58ef2fb8db9e66b2eec3",
"type": "application/json"
},
"profile": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231",
"type": "application/json"
},
"customer": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231/customers/customer_65382f2a7d804ccdb2021a7ede90680",
"type": "application/json"
},
"payment-method": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231/customers/payment-methods/payment_method_4c52e9aee8874f6ab7ed0420f649b5e2da3",
"type": "application/json"
}
}
}Example response after authorisation:
{
"id": "payment_e04fd81843b943c58ef2fb8db9e66b2eec3",
"method": "openbanking",
"currency": "EUR",
"amount": 2283,
"sepa": {
"last4": "8606",
"bic": "ABNANL2A",
"country": "NL",
"holder_name": "JH DOE"
},
"openbanking": {
"method": "sepa",
"bic": "ABNANL2AXXX",
"country": "NL"
},
"description": "Test description",
"state": "succeeded",
"metadata": null,
"created": "2023-19-12T08:30:35.758Z",
"_links": {
"self": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231/payments/payment_e04fd81843b943c58ef2fb8db9e66b2eec3",
"type": "application/json"
},
"profile": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231",
"type": "application/json"
},
"customer": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231/customers/customer_65382f2a7d804ccdb2021a7ede90680",
"type": "application/json"
},
"payment-method": {
"href": "/v1/profiles/profile_c4f5e275fe28fc98b38f90231/customers/payment-methods/payment_method_4c52e9aee8874f6ab7ed0420f649b5e2da3",
"type": "application/json"
}
}
}Last updated
Was this helpful?