Skip to main content
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.
​
date
required
yyyy-MM-dd.
​
date
required
yyyy-MM-dd.
​
uuid
Restrict to one customer (the customer GUID).
​
uuid
Restrict to one merchant (agency credentials).
​
string
merchant — when the credential can see several merchants, restrict to the one it belongs to.
​
integer
Page to return.
​
integer
Items per page.
​
integer | string
Numeric for processed payments; otherwise the BPay payment reference string.
​
string
YYYY-MM-DDTHH:MM:SS, no time zone.
​
uuid | null
The customer GUID, despite the name.
​
number
What the payer sent, what was deducted, what’s payable to you.
​
integer
1 bank account, 0 other.
​
string | null
The customer’s BPay reference number.
This endpoint uses the Billing envelope and needs Accept: application/json. It doesn’t return from_item / to_item / total_count even when paging parameters are supplied.