---
title: "GET /billpay/{billPayNumber}"
method: GET
path: "/billpay/{billPayNumber}"
---

# GET /billpay/{billPayNumber}

`GET /billpay/{billPayNumber}`

Queries for BillPay number details

## Path parameters

- `billPayNumber` string, required

## Response `200`

Successfully queried for BillPay number details

- object[]
  - `updatedAt` string, date-time — Last updated timestamp
  - `createdAt` string, date-time — Creation timestamp
  - `id` string — Payout ID
  - `orderReference` string — Associated order reference
  - `amount` string — Payout amount
  - `currency` string — Currency code
  - `fee` string — Transaction fee
  - `status` 'SUCCESS' | 'PROCESSING' | 'PENDING' | 'FAILED' | 'REFUNDED' | 'REVERSED' — Payout status
  - `channel` 'BANK TRANSFER' | 'MOBILE MONEY' — Payout channel
  - `channelProvider` string — Name of the payout channel provider
  - `transferType` 'ACH' | 'RTGS' — Transfer type - when applicable
  - `notes` string — Additional notes if available
  - `beneficiary` object
    - `accountNumber` string — Beneficiary's account number
    - `accountName` string — Beneficiary's account name
    - `swiftNumber` string — SWIFT number if applicable
    - `routingNumber` string — Routing number if applicable
    - `beneficiaryMobileNumber` string — Beneficiary's mobile number if applicable
    - `beneficiaryEmail` string, email — Beneficiary's email if applicable
  - `clientId` string — Application Client ID associated with the payout

## Other responses

- `401` — Unauthorized
- `404` — Not found

---

[API](https://skmtc.net/clickpesa/apis/core-api-openapi-specification.md) · [All operations](https://skmtc.net/clickpesa/apis/core-api-openapi-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clickpesa/core-api-openapi-specification/versions/9f70f35c5590/schema)