Create a Beneficiary

post

https://dev.sivo.com/v1/banking/beneficiaries

Create a beneficiary

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a beneficiary

string

An email address

beneficiaryAddress

string

length ≥ 1

beneficiaryCountry

string

^(?!UK$)[A-Z]{2}$

A country identifier in 2 uppercase letters. See ISO-3166-Alpha2

accountNumber

string

length ≥ 1

routingCodeType1

string

enum

routingCodeValue1

string

length ≥ 1

routingCodeType2

string

enum

routingCodeValue2

string

length ≥ 1

bicSwift

string

length ≥ 1

iban

string

length ≥ 1

defaultBeneficiary

string

length ≥ 1

bankAddress

string

length ≥ 1

bankName

string

length ≥ 1

bankAccountType

string

enum

Allowed:

beneficiaryCompanyName

string

length ≥ 1

beneficiaryFirstName

string

length ≥ 1

beneficiaryLastName

string

length ≥ 1

beneficiaryCity

string

length ≥ 1

beneficiaryPostcode

string

length ≥ 1

beneficiaryStateOrProvince

string

length ≥ 1

beneficiaryDateOfBirth

date-time

See Dates and Times for details

beneficiaryIdentificationType

string

enum

beneficiaryIdentificationValue

string

length ≥ 1

paymentTypes

array of objects

paymentTypes

Allowed:

beneficiaryExternalReference

string

length ≥ 1

businessNature

string

length ≥ 1

companyWebsite

string

^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-zA-Z0-9]+([\-\.]{1}[a-zA-Z0-9]+)*\.[a-zA-Z]{2,}?\/?$

A website address

name

string

required

length ≥ 1

bankAccountHolderName

string

required

length ≥ 1

bankCountry

string

required

^(?!UK$)[A-Z]{2}$

A country identifier in 2 uppercase letters. See ISO-3166-Alpha2

beneficiaryEntityType

string

enum

required

Allowed:

currency

string

required

^[A-Z]{3}$

A currency identifier in ISO-4217 format

Responses

405

Invalid input

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation