Create Hosted Payout

Hosted Payouts feature requires to have completed the steps for integrating a verified payout. In other words, it requires to have created a public/private openSSL RSA 2048 bit keypair, registered your public key in our platform through the admin dashboard and finally use the above private to sign the request. If you have already done it for the payouts it is not necessary to go over the procedure. For more detailed guide on the above, check the signature section.

Use the following to make use of our standard verified pay-out journey. However, it is worth mentioning that hosted-payouts require the request to be signed in order to authenticate the merchant, before receiving the final link.

To generate the link you will need to call the following endpoint from your backend as it will use your merchant private api key along with signing details, such as expiration time and base64 encoded signature.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Used to identify the customer whose bank account details to fetch

string
enum
required

Payment rail for the counter party bank account. Depending of the currency of the transaction it can be either FPS (UK faster payments) or SEPA (EU SEPA Inst)

Allowed:
number
required

Decimal value of the payout - string with number with 2 decimal places

string
required
Defaults to GBP

string with valid ISO currency code

string
required

Reference for the payout (max 15 chars). This MUST be unique

string

description shown to the customer

string

searchable string

string

meta-data of the request

string

It redirect the page that the modal is shown in completion of the journey

string

It redirect the page that the modal is shown in case of closing the modal on failed status

string

Url that the user is redirected to from their bank app on a successful approval

string

Url that the user is redirected to from their bank app on a cancelled/failed request

string
Defaults to en

The language ISO-639-1 code that will be used to translate the journey

string

Bank to be used for the transaction. Merchant can send it for so-called 'single bank' functionality. This is a bank that will be used for the transaction. If not provided, the user will be able to select the bank from the list.

boolean
Defaults to false

Prevents user from removing existing bank accounts or adding new ones.

customerDetails
object
string

The customer email address

boolean
Defaults to false

A boolean to specify whether you want to enqueue your payout

boolean
Defaults to false

encrypt payload field

Headers
string
required

Your merchant private api key

string
required

UNIX timestamp for the signature expiration

string
required

Base64 encoded signature

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain