Contacts API
Manage customer contacts and their payment instruments (wallet addresses).
Contacts
Create Contact
POST /api/contacts
Create a new contact (customer record).
| Field | Type | Required | Description |
|---|---|---|---|
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
email | string | No | Email address |
externalId | string | No | Your internal customer ID |
type | string | No | INDIVIDUAL 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.
| Query | Type | Description |
|---|---|---|
ids | UUID[] | 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.
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Instrument type (e.g., CRYPTO_WALLET) |
address | string | Yes | Wallet address or account number |
network | string | Conditional | Required for crypto wallets |
label | string | No | Display 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.
| Query | Type | Description |
|---|---|---|
type | string | Filter by instrument type |
offset | number | Pagination offset |
limit | number | Page size |