Create stored recipient

Creates new stored recipient and returns its identifier.

Body Params
string
required

The two-character ISO 3166-1 alpha-2 country code. For cheques, you must use US. For United Kingdom, use GB (not UK).

string
required

The recipient currency, in ISO 4217 currency code format, for example USD or GBP.

string
enum
required

Indicates whether the recipient is a private individual or a registered business so the system can apply the right compliance, tax, or account verification rules.

Allowed:
string
required

Identifies the person or business receiving the payment.

string | null

The recipient’s email address.

string | null

The recipient’s phone number.

string | null

Links the Vitesse stored recipient to the corresponding recipient record in your system.

string | null

Provides secondary reference data, such as a building society roll number, used to identify the recipient’s account.

CoPDetails
object | null

Confirmation of Payee details for the payment recipient.

string
enum
required

How the recipient receives payment, for example by BankAccount or Echeck. For more information, see Payment methods.

Allowed:
Address
object | null

The recipient’s postal address in structured form. For more information, see Structured addresses.

BankAccountDetails
object
required

Contains the bank account details used to route payments to the recipient.

Person
object | null

When sending money to a private individual as opposed to a registered business. Contains the recipient’s personal details.

Business
object | null

Contains the recipient’s business details.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json