Add Contact

post

https://api.soldo.com/business/v2/contacts

Endpoint to add a new Contact.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Required scopes:

contact_write

Fingerprint order:

name,type,country,join(concat(account_info.type,account_info.identification)),userId,token

Body Params

Create Contact JSON parameters.

name

string

required

The name of the Contact. It must start with a letter and contain only unaccented letters, spaces and the characters ', ,, . and -; it must be at most 70 characters long (40 for UK bank accounts, identified by SORT_CODE and ACCOUNT_NUMBER). It is checked against the account holder name registered by the bank: if they do not fully match, the response contains the details in validation, and the Contact is saved with the provided name anyway.

user_id

string

The ID of the User the Contact is assigned to. It can be set only when type is EMPLOYEE.

type

string

enum

required

The new type of the Contact. The type of a Contact of type ACCOUNT cannot be changed. If omitted, the current value is kept.

Allowed:

account_info

array of objects

required

The bank account details of the Contact. Provide either a single IBAN entry (SEPA bank account) or both a SORT_CODE and an ACCOUNT_NUMBER entry (UK bank account).

account_info*

country

string

enum

required

The ISO 3166-1 alpha-3 code of the country where the Transaction has been authorised.

bic

string

The BIC (SWIFT code) of the bank of the Contact. When provided, it is used to verify the bank account details.

account_type

string

enum

required

The account type of the payee when the Request paymentMethod is BANK_TRANSFER.

Allowed:

Headers

X-Soldo-Fingerprint

string

required

Defaults to {{fingerprint}}

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

X-Soldo-Fingerprint-Signature

string

required

Defaults to {{fingerprint_signature}}

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Responses

400

Your request has missing arguments or is malformed.

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

Required scopes:

Fingerprint order:

200The returned resource is a single Contact.