Our Hosted Checkout offers the simplest way to integrate account-to-account payments on your website. Make a single API request to create a payment session and redirect your customer to the URL provided in the response. Banked manages the entire process, including data collection, bank selection, and payment authorization, ensuring a seamless experience for you and your customers. Try out here:
Hosted Checkout DemoSupported Regions:
- EU
- UK
- US
- AU
Integration Guide:
Before integrating Banked Hosted Checkout, ensure you have read the Authentication section in Welcome to Banked. Once you have obtained your authentication keys, follow these steps to embed our checkout into your application:
1. Create a Payment Session
When a customer confirms their order, create a Payment Session using POST /v2/payment_sessions. Refer to the following documentation for detailed instructions on creating payment sessions:
Example
{
"reference": "Test Payment Session",
"error_url": "http://example.com/error",
"success_url": "http://example.com/success",
"email_receipt": false,
"line_items": [{
"name": "Candles",
"amount": 200,
"currency": "GBP",
"quantity": 1
}],
"payee": {
"name": "Current Account",
"account_number": "12345678",
"sort_code": "010203"
},
"payer": {
"name": "Test",
"email": "foo@baa.com"
}
}
The success_url and error_url on the payment session request will be used to redirect the customer back to your application once the Checkout journey ends. Both these parameters are optional. Banked provides a default error_url, see Banked Default Error Url
{
"amount": 400,
"created_at": "2019-11-01 15:48:26 UTC",
"currency": "GBP",
"end_to_end_id": "728d061b-8e47-4052-be4f-5f9bcdee39ff",
"error_url": "http://example.com/error",
"id": "1ae1ce03-dfa9-4593-b487-65c656991cb5",
"line_items": [
{
"amount": 200,
"currency": "GBP",
"description": null,
"name": "Candles",
"quantity": 1
}
],
"live": true,
"payee": {
"name": "Current Account",
"account_number": "12345678",
"sort_code": "010203"
},
"payer": {
"email": "demo+0.4371035245462651@banked.com",
"name": "Checkout Demo User"
},
"reference": "Test Payment Session",
"state": "awaiting_provider",
"success_url": "http://example.com/success",
"url": "https://checkout.banked.com/uk/1ae1ce03-dfa9-4593-b487-65c656991cb5?token={unique-access-token}",
"email_receipt": true
}
2. Direct the User to the Checkout URL
Direct the customer to the url provided in the payment session response. The customer will then complete payment authorization through our Hosted Checkout experience. To explore available options for customizing the Hosted Checkout, refer to the link below:
3. Handle Checkout Redirect
After a customer exits the checkout flow, the checkout redirects them to the success_url or error_url provided during payment session. Banked appends the following parameters to the redirect url to provide context on the payment, customer action and resulting payment status:
| Parameters | Description |
|---|---|
banked-checkout-result | See Banked Checkout Result |
payment_result | See Payment Result |
payment_id | See Payment ID |
For detailed information on how to handle the Checkout Redirect see:
Checkout Redirects