Skip to main content

Contacts API

Manage customer contacts and their payment instruments (wallet addresses).


Contacts

Create Contact

POST /api/contacts

Create a new contact (customer record).

FieldTypeRequiredDescription
firstNamestringYesFirst name
lastNamestringYesLast name
emailstringNoEmail address
externalIdstringNoYour internal customer ID
typestringNoINDIVIDUAL or BUSINESS

Get Contact

GET /api/contacts/{id}


Get Contacts by IDs

GET /api/contacts/batch

Retrieve multiple contacts by their IDs in a single request.

QueryTypeDescription
idsUUID[]Comma-separated list of contact IDs

Update Contact

PUT /api/contacts/{id}


Payment Instruments

Payment instruments represent a customer's payment methods (wallet addresses, bank accounts).

Add Payment Instrument

POST /api/contacts/{id}/instruments

Add a payment instrument to a contact.

FieldTypeRequiredDescription
typestringYesInstrument type (e.g., CRYPTO_WALLET)
addressstringYesWallet address or account number
networkstringConditionalRequired for crypto wallets
labelstringNoDisplay label

List Payment Instruments (Contact)

GET /api/contacts/{id}/instruments

List all payment instruments for a specific contact.


Update Payment Instrument

PUT /api/contacts/{id}/instruments/{instrumentId}


Remove Payment Instrument

DELETE /api/contacts/{id}/instruments/{instrumentId}


List All Payment Instruments

GET /api/instruments

List all payment instruments across all contacts.

QueryTypeDescription
typestringFilter by instrument type
offsetnumberPagination offset
limitnumberPage size