Create stored recipient

post

https://staging-api.vitessepsp.com/api/storedRecipient

Creates a stored recipient for the current merchant.

Body Params

Stored recipient details.

ExternalStoredRecipientId

string

required

length between 1 and 64

Identifies the stored recipient in your system, using your unique reference.

Status

string

enum

The stored recipient status.

Allowed:

UpdatedOn

date-time

When the stored recipient was last updated.

Name

string

required

length between 0 and 256

The recipient name.

Type

string

enum

The recipient type. Valid values are Person and Business.

Allowed:

Country

string

required

length between 2 and 2

The recipient country, in ISO 3166-1 alpha-2 country code format.

Currency

string

required

length between 3 and 3

The recipient currency, in ISO 4217 currency code format.

Account

object

required

Recipient account details used to route the payment. Required fields vary by country, currency, and payment route. Use the Rules API to determine which account fields are required for a specific payment.

Address

object

Structured postal address details aligned to ISO 20022. For address requirements and usage rules, see Structured addresses.

Birthdate

date-time

The recipient birthdate.

Nationality

string

length between 2 and 2

The recipient nationality, in ISO 3166-1 alpha-2 country code format.

string

length between 0 and 128

The recipient email address.

PhoneNumber

string

length between 0 and 32

The recipient phone number.

ReferencePrefix

string

length between 0 and 256

The prefix added to the recipient reference.

ConfirmationOfPayee

object

Confirmation of Payee request and response details.

UrgentPaymentRecipient

object

The recipient details used for urgent payments.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200OK

400BadRequest