Account Verifications allow merchants to request customers complete a journey to share bank data from their banking app. These details are returned via a webhook to the merchant.

To make an Account Verification instruction and get journey url, the merchant will call Yaspa's HTTPS API Endpoint.

API Request

The following call is an HTTPS POST request

Headers

The following header must be attached to the request.

For security reasons a Signature and Expires-at header needs to be attached. See Instant Payouts - Signing Payout Instructions for more details.

Header	Description
AuthorizationCitizen	This is the merchant api key from the Admin Dashboard - found on the Company Settings page. This secures the request to the merchant account
Content-Type	'application/json'

Header

Description

AuthorizationCitizen

This is the merchant api key from the Admin Dashboard - found on the Company Settings page.

This secures the request to the merchant account

Content-Type

'application/json'

Body - Mandatory Fields

The body of the request is a json object, the following keys/values are mandatory on the request

key	Description	Values	Example
customerIdentifier	The merchant string reference for the customer. This must be unique per the customer. Yaspa uses the customerIdentifier to create saved accounts, so it's important no two customers share the same customerIdentifier.	String	"5f767df845"
reference	A unique reference for the payment, this will be used in payment reconciliation. This must be unique for the merchant account and less than 17 characters, this is a limitation passed on from the bank	String	"gjkhg43hjkfds43"
journeyType	This changes aspects of the customer journey, allowing the merchant to gather additional data about the customer. Values are: HOSTED_ACCOUNT_VERIFICATION - Journey to request access to the customer's bank details.	String	HOSTED_ACCOUNT_VERIFICATION
supportedCountries	The first element in this array will be the default country shown to the customer within the bank selector. Customers are free to change the country using a select box in the bank selector. If the merchant selects ["GB"] only the British banks are shown, if a European country is passed through - for example ["NL"] - Netherlands will be shown. If the country isn't recognised or supported Netherlands will be shown	array	["GB"] or ["NL"] or ["DE"]

Body - Example body

Below is an example body of a payout instruction.

Please change the reference each time a payout instruction is used.

{
    "customerIdentifier": "{{randomString}}",
    "journeyType": "HOSTED_ACCOUNT_VERIFICATION",
    "reference": "{{randomString}}",
    "supportedCountries":["NL"]
    
}

API Response

Response Body

The response body will contain a url for the customer journey, this should be sent to the merchant website and displayed to the customer

Example:

https://test-banks.yaspa.com/hosted/account-verification?transaction-id=cabcbaf0-2873-521a-630c-22c49d&secondTimeUser=false