> For the complete documentation index, see [llms.txt](https://docs.udara360.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.udara360.io/udara360-docs-1/bills-payments/bill-payments/get-customer-user-id-information.md).

# Get Customer (User ID) Information

The "Get Customer (User ID) Information" endpoint allows customers to retrieve billing and payment details for a specific biller customer, before initiating a payment.

<mark style="color:green;">`GET`</mark> `/api/Bills/v1/GetCustomerInformation`

To retrieve customer information, you need to provide the query parameters `CustomerId`, `GlobalBillerIdentifier`, and `ProductName`.

**Headers**

| Name                                            | Value                |
| ----------------------------------------------- | -------------------- |
| Content-Type<mark style="color:red;">\*</mark>  | `application/json`   |
| Authorization<mark style="color:red;">\*</mark> | `Bearer`             |
| Request-Reference                               | `{unique_reference}` |

**Query Params**

| Name                     | Description                                                                                                                   |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| `CustomerId`             | The customer's identifier with the biller (e.g. a meter number, smart card number, or phone number, depending on the biller). |
| `GlobalBillerIdentifier` | The identifier of the biller to query, e.g. DSTV.                                                                             |
| `ProductName`            | The specific product/package to query, e.g. COMPACT\_PLUS.                                                                    |

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

<details>

<summary>Sample Request</summary>

```json
curl --location -g '{{baseurl}}/api/Bills/v1/GetCustomerInformation?CustomerId=0101160313181&GlobalBillerIdentifier=DSTV&ProductName=COMPACT_PLUS' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''
```

</details>

<details>

<summary>Response: <code>200</code></summary>

```json
{
  "status": true,
  "message": "string",
  "data": {
    "customer": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phoneNumber": "string",
      "totalDue": "string",
      "dueDate": "2024-11-13T01:45:38.915Z",
      "customerName": "string",
      "meterNumber": "string",
      "accountNumber": "string",
      "canVend": true,
      "products": [
        "string"
      ]
    },
    "orderId": "string",
    "minAmount": 0,
    "minPayableAmount": 0,
    "minPayableAmountInKobo": 0,
    "customerMessage": "string",
    "billerName": "string",
    "paid": true,
    "paymentReference": "string",
    "vendStatus": "string",
    "narration": "string",
    "amount": 0,
    "amountInKobo": 0,
    "date": "2024-11-13T01:45:38.915Z",
    "confirmationTime": "2024-11-13T01:45:38.915Z",
    "commission": 0,
    "commissionInKobo": 0
  }
}
```

</details>
