Fetch Customer

Retrieves a Customer's details

Retrieves a customer with the specified id.

GET/v1/customers/{id}

Path parameters

id*string

The id of the entry to retrieve

Response

200400401404

Returns 200 and the requested customer

Body

application/json

idnullable string

full_namenullable string

Customer's full name (OPTIONAL)

emailnullable string

Customer's email (REQUIRED)

phone_numbernullable string

Customer's phone number (OPTIONAL)

addressnullable string

Customer's address (OPTIONAL)

statusCustomerStatus (enum)

activeblacklisted

created_atstring (date-time)

Timestamp when the customer was created.

edited_atnullable string (date-time)

Timestamp when the customer was last updated.

dedicated_virtual_accountsnullable array of ViewCustomerDedicatedVirtualAccountDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/customers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "full_name": "text",
  "email": "text",
  "phone_number": "text",
  "address": "text",
  "status": "active",
  "created_at": "2024-11-16T16:42:32.016Z",
  "edited_at": "2024-11-16T16:42:32.016Z",
  "dedicated_virtual_accounts": [
    {
      "id": "text",
      "is_live": false,
      "account_reference": "text",
      "gateway_code": "text",
      "callback_url": "text",
      "account_name": "text",
      "account_number": "text",
      "country": "text",
      "bank_code": "text",
      "bank_name": "text",
      "currency": "text",
      "bvn": "text",
      "metadata": "text",
      "created_at": "2024-11-16T16:42:32.016Z",
      "edited_at": "2024-11-16T16:42:32.016Z",
      "customer_id": "text",
      "payout_tag": "text",
      "payout_tag_description": "text",
      "payout_tag_metadata": "text"
    }
  ]
}