Create and Initiate Payout

post

https://testapi.yaspa.com/v2/payouts/verified/transaction/initiate

Creates and initiates a direct payout in a single call, without any customer UI interaction.

Use this instead of Create Payout Session + Submit Payout Session when you already hold the customer's bank account details, or their Yaspa customer bank account ID.

Direct Payouts require 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

length ≤ 1024

Used to identify the customer whose bank account details to fetch

customerEmailAddress

string

length ≤ 320

Customer email address which is used if using the payout journey

paymentGiro

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:

amount

string

required

Decimal value of the payout - string with number with 2 decimal places. Must not be zero.

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

customerBankAccount

required

Customer bank account details. Set type to choose how the account is identified: CustomerAccountId to reuse an account Yaspa has already verified, AccountNumberAndSortCode for FPS, or IbanAndBic for SEPA.

customerIpAddress

string

Defaults to 0.0.0.0

IP address of the customer receiving the payout

customerDeviceOs

string

Defaults to N/A

OS for the customer receiving the payout

searchableText

string

searchable string

payload

string

meta-data of the request

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

Signature

string

required

The signature that you sign the request

Expires-at

int64

required

The expiration time of the signature on unix timestamp format.

Response

200Details of the payout