Creating Counter Party

post

https://testapi.yaspa.com/v2/corporate-account/admin-counter-party

The first step to make withdrawals is to create a counter party. This request is typically created from your back end. The request uses your merchant private API key (from your admin dashboard) and the body must be signed with the signature set as a request header.

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

bankCountry

string

required

The jurisdiction of the counter party account. it should follow the country ISO codes. For example supported countries are [GB], [IE], [NL]

accountGiro

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:

accountCurrency

string

required

Counter party account currency. The supported currencies are "GBP" and "EUR".

accountName

string

required

Account name of the counter party

accountNumber

string

required

For transaction within the UK the sort code or for EUR the iban for the counter party

bankCode

string

required

The counter party sort code/bic

counterPartyBank

string

required

Bank of the counter party. If this account was created via a third party such as OPENPAYD, then this should be set to "OPENPAYD".

customerType

string

enum

required

Type of the counter party. If this account is used for withdrawal in admin dashboard, then this should be set to "CORPORATE". Otherwise, using "RETAIL" for regular payouts

Allowed:

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 counter party