Skip to main content

Add a Contact

Contacts represent your customers in WickiePay. Associate wallet addresses and payment instruments with customer records for compliance and tracking.

Create a Contact​

POST /api/contacts

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "externalId": "your-customer-id-123",
  "type": "INDIVIDUAL"
}

Add a Payment Instrument​

Associate a wallet address with a contact:

POST /api/contacts/{contactId}/instruments

{
  "type": "CRYPTO_WALLET",
  "address": "0xCUSTOMER...WALLET",
  "network": "ETHEREUM",
  "label": "John's main wallet"
}

Use Contacts with Payments​

When creating payments, you can associate them with a contact for Travel Rule compliance and record-keeping:

{
  "complianceDetails": {
    "beneficiary": {
      "name": "John Doe",
      "accountNumber": "0xCUSTOMER...WALLET",
      "country": "DE"
    }
  }
}

Manage Contacts​

ActionAPI
Get contactGET /api/contacts/{id}
Update contactPUT /api/contacts/{id}
List instrumentsGET /api/contacts/{id}/instruments
Update instrumentPUT /api/contacts/{id}/instruments/{instrumentId}
Remove instrumentDELETE /api/contacts/{id}/instruments/{instrumentId}

Next Steps​