Sign in

v1

latestOpenAPI 3.0.02026-07-243678114.1 KB
Customers

Get Customer by ID

The Get Customer by ID endpoint allows you to retrieve detailed information about a specific customer using their unique identifier. Use this endpoint to access and manage individual customer records within your organization.

get/v1/customers/{customerID}

Path parameters

customerIDstring required

Unique identifier of the customer. Supports either BoomFi's Customer ID or the unique reference identifier set in a paylink for the customer.

Response

OK

errorboolean

Example response

{
  "data": {
    "created_at": "2023-03-15T08:30:00Z",
    "customer_ident": "CUST123",
    "email": "example@email.com",
    "id": "123456789",
    "last_payment_date": "2023-03-20T12:00:00Z",
    "name": "John Doe",
    "organisation_id": "ORG123",
    "payments_count": 5,
    "updated_at": "2023-03-25T10:45:00Z",
    "wallet_address": "0x4bbeEB066eD09B7AEd07bF39EEe0460DFa261520"
  }
}