> ## Documentation Index
> Fetch the complete documentation index at: https://developers.paychoice.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# BPay

> Report on BPay payments received for your customers.

Customers with a BPay customer reference number (`crn`) can pay through their own bank. PayChoice receives the payment and matches it to the customer. `GET /Bpay` lets you report on those payments for a date range.

```bash theme={null}
curl "https://api-sandbox.paychoice.com.au/api/v4/Bpay?fromdate=2026-07-26&todate=2026-08-15&page[number]=1&page[items]=5" \
  -u "$PAYCHOICE_USERNAME:$PAYCHOICE_PASSWORD" \
  -H "Accept: application/json"
```

**fromdate** `date` *required*

`yyyy-MM-dd`.

**todate** `date` *required*

`yyyy-MM-dd`.

**customerid** `uuid`

Restrict to one customer (the customer GUID).

**merchant\_guid** `uuid`

Restrict to one merchant (agency credentials).

**filter** `string`

`merchant` — when the credential can see several merchants, restrict to the one it belongs to.

**page\[number]** `integer`

Page to return.

**page\[items]** `integer`

Items per page.

```json theme={null}
{
  "status": "Success",
  "code": 200,
  "messages": [ { "message_text": "Data Selected", "message_type": "success" } ],
  "bpay": {
    "payments": [
      {
        "id": 90123456,
        "date": "2026-07-31T00:00:00",
        "customer_id": "8c34513b-61e0-4f8a-b007-af4fe9479bf4",
        "payable_amount": 96.8,
        "fee": 3.2,
        "received_amount": 100,
        "payment_method": 1,
        "crn": "55069000061021",
        "merchant": { "guid": "315564b9-b863-4016-8c53-02c9d8cc80b7", "name": "Example Gym Pty Ltd" },
        "payment_reference": "123456789"
      }
    ]
  },
  "object_type": "bpay",
  "link": { "href": "/api/v4/Bpay?fromdate=2026-07-26&todate=2026-08-15", "rel": "self" }
}
```

**id** `integer | string`

Numeric for processed payments; otherwise the BPay payment reference string.

**date** `string`

`YYYY-MM-DDTHH:MM:SS`, no time zone.

**customer\_id** `uuid | null`

The customer GUID, despite the name.

**received\_amount / fee / payable\_amount** `number`

What the payer sent, what was deducted, what's payable to you.

**payment\_method** `integer`

`1` bank account, `0` other.

**crn** `string | null`

The customer's BPay reference number.

This endpoint uses the [Billing envelope](https://developers.paychoice.com.au/billing/overview.md) and needs `Accept: application/json`. It doesn't return `from_item` / `to_item` / `total_count` even when paging parameters are supplied.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.