Get a Beneficiary by Id

get https://dev.sivo.com/v1/banking/beneficiaries/{id}

Find a beneficiary by Id

Responses

Response body

object

beneficiaryAddress

array of strings

required

beneficiaryAddress*

bankAddress

array of strings

required

bankAddress*

defaultBeneficiary

string

required

length ≥ 1

creatorContactId

string

required

A universal identifier (all lowercase)

name

string

required

length ≥ 1

bankAccountHolderName

string

required

length ≥ 1

bankCountry

string

required

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

beneficiaryEntityType

string

required

company individual

currency

string

required

A currency identifier in ISO-4217 format

string

An email address

beneficiaryCountry

string

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

accountNumber

string

length ≥ 1

routingCodeType1

string

sort_code aba bsb_code institution_no bank_code branch_code clabe cnaps ifsc bic_swift ach_routing_number wire_routing_number routing_code

routingCodeValue1

string

length ≥ 1

routingCodeType2

string

sort_code aba bsb_code institution_no bank_code branch_code clabe cnaps ifsc bic_swift ach_routing_number wire_routing_number routing_code

routingCodeValue2

string

length ≥ 1

bicSwift

string

length ≥ 1

iban

string

length ≥ 1

bankName

string

length ≥ 1

bankAccountType

string

checking savings

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

none others employer_identification_number clave_unica_de_registro_de_poblacion registro_federal_de_contribuyentes national_id incorporation_number drivers_license social_security_number green_card passport visa matricula_consular credential_de_elector social_insurance_number citizenship_papers drivers_license_canadian existing_credit_card_details

beneficiaryIdentificationValue

string

length ≥ 1

paymentTypes

array of strings

paymentTypes

beneficiaryExternalReference

string

length ≥ 1

businessNature

string

length ≥ 1

companyWebsite

string

A website address

400

Invalid ID supplied

404

Beneficiary not found

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://dev.sivo.com/v1/banking/beneficiaries/ \
3
     --header 'accept: application/json'

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

application/json

200Successful operation