Create Payout Session

post

https://testapi.yaspa.com/v2/payouts/verified/session

The Create Payout session request is used to make a payout to the customer without any customer UI interactions, the merchant will go on to specify the customer bank account to be used.
Direct Payouts feature requires the merchant to have previously created a public/private openSSL RSA 2048 bit key pair - this is used to sign the payout.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customerIdentifier

string

required

Used to identify the customer whose bank account details to fetch

customerEmailAddress

string

Customer email address which is used if using the payout journey

paymentGiro

string

enum

required

payment type (SEPA or FPS)

Allowed:

amount

number

required

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

currency

string

required

Defaults to GBP

string with valid ISO currency code

reference

string

required

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

customerIpAddress

string

required

IP address of the customer receiving the payout

customerDeviceOs

string

required

OS for the customer receiving the payout

searchableText

string

searchable string

payload

string

meta-data of the request

supportedCountries

array of strings

filter the bank list in bank selection page by country ISO code

supportedCountries

successRedirectUrl

string

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

failureRedirectUrl

string

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

successBankRedirectUrl

string

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

failureBankRedirectUrl

string

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

language

string

Defaults to en

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

customerDetails

object

isQueued

boolean

Defaults to false

A boolean to specify whether you want to enqueue your payout

Headers

AuthorizationCitizen

string

required

Your merchant private api key

Expires-at

string

required

UNIX timestamp for the signature expiration

Signature

string

required

Base64 encoded signature

Response

200A payout transactionId