Help Instance Help

View List of beneficiary Contacts

Returns list of Contacts for requested Customer

Endpoint

Request Type

URL

GET

https://{EnvironmentURL}/contacts/customers/{customerId}/contacts

Headers

No headers

Request parameters

Parameter

Type

Mandatory

Description

customerId

uuid

Yes

Identifier of the Customer, owner of the Contact

currency

string

Yes

Currency of the Contact

pageNumber

int

No

Pagination Parameter

pageSize

int

No

Pagination Parameter

Responses

200 OK - Success

Body - JSON

Wrapper - Paginated Response

total

int

Yes

Total number of objects in the list

data

object

Yes

Response

Data - Collection of Contact entity

Parameter

Type

Mandatory

Description

contactId

uuid

Yes

Identifier of the contact

accountId

uuid

Yes

Identifier of the Account in case if Beneficiary is a Customer of Digidoe

type

string

Yes

Type of the Beneficiary

Allowed values:

  • 1) 'sort_code' for Account in UK

  • 2) 'IBAN' for SEPA Zone

currency

string

Yes

Code of the Currency of the Beneficiary Account

Allowed values:

  • 1) gbp

  • 2) eur

accountHolderName

string

Yes

Name of Beneficiary

details

object

Yes

Beneficiary Account details

iban

string

Conditional

Beneficiary Account IBAN

Mandatory only in case of "type" = 'IBAN' (for SEPA)

sortCode

string

Conditional

Beneficiary Account Sort Code

Applicable only in case of type = 'sort_code (for Faster Payments)

accountNumber

string

Conditional

Beneficiary Account Number

Applicable only in case of type = 'sort_code (for Faster Payments)

legalType

string

Yes

Legal type of Beneficiary

Allowed values:

  • 1) PRIVATE

  • 2) BUSINESS

address

object

Yes

Address of the Beneficiary

address.country

string

Yes

Name of the Country

address.countryCode

string

Yes

ISO 3166-1 alpha-2 code of the Country

address.state

string

No

State, if applicable for Country

address.city

string

Yes

Name of the City

address.postcode

string

No

Postcode

address.firstline

string

Yes

Address line

400 Bad request

Invalid format of the request

401 - Unauthorized

No Body

Last modified: 19 января 2024