Create Hosted Payin

post

https://testapi.yaspa.com/v2/payins/hosted-payin/generate-link

Use the following to make use of our standard pay-in journey.

To generate the link you will need to call the following endpoint from your backend as it will use your merchant private api key.

You will then get a URL to the hosted page. It has an expiry of 1 week. Once expired you will need to generate a new hosted pay-in.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customerIdentifier

string

required

The internal id you use on your systems to identity your user

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 payment

currency

string

required

Defaults to GBP

ISO currency code

reference

string

required

payment reference shown to the customer. Needs to be alphanumeric and 15 chars max. This MUST be unique

journeyType

string

enum

the type of the journey

Allowed:

customerEmailAddress

string

The email of the paying customer. Only needed for email journey

description

string

description shown to the customer

searchableText

string

searchable string

payload

string

meta-data of the payment

supportedCountries

array of strings

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

supportedCountries

successRedirectUrl

string

the page redirection for a successful payin

failureRedirectUrl

string

the page redirection for a failure payin

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

testParameters

object

Test parameters are used to test journey in different scenarios, like uncompleted transactions, etc.

bank

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.

disableAddingNewBanks

boolean

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

customerDetails

object

customConsentExpiryDays

int32

The number of days in which the consent behind the associated account verification should expire. If not provided the default logic from the AISP will be used

Headers

AuthorizationCitizen

string

required

Your merchant private api key

Response

308A link for a Hosted Pay-In