List payments

get

https://test-api.bill.pro/api/v2/profiles/{profile_id}/payments

Returns the profile's payments, newest first, one page at a time. Refunds, captures, reversals and declined attempts are payments too, each in its own row.

Each row is a summary. For the card, 3-D Secure and Pay.on result details, show the payment.
Filters combine: a row must match every filter you send. A filter with several values matches any of them.
Most filters that match nothing return an empty page, not an error. payment_type is the exception: an unrecognised value is ignored.
Page size is 20 by default, up to 100.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profile_id

integer

required

≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

Query Params

string

Search term. Matches part of the customer's first name, last name, full name, organisation, email or customer ID. Not case-sensitive. Because it matches part of the ID, 12 also finds customers 120 and 512: use customer_id for one customer. It doesn't search payment or order IDs.

uid

string

ID of the order. Exact match. One ID only: a comma list matches nothing.

spid

string

ID of a scheduled payment. Returns every attempt to collect it, retries included. Payments that weren't scheduled never match. One ID only.

gateway_id

string

Pay.on's ID for the transaction, as in original_id. Exact match, case-sensitive. One ID only.

customer_id

integer

ID of the customer, as in the row's customer_id. Not your own customer reference. One ID only: customer_id[]= and comma lists match nothing. An ID that isn't on this profile returns no results, not an error.

transaction_type

array of strings

One or more transaction types, such as db or rf. See the payment's transaction_type for what each one means. Send a single value (transaction_type=db), a comma list (transaction_type=db,rf) or a repeated array parameter (transaction_type[]=db&transaction_type[]=rf). An unrecognised value matches nothing.

transaction_type

payment_result

array of integers

One or more results, as numbers: 1 approved, 2 soft decline, 3 hard decline. Names such as Approved match nothing. Accepts the same forms as transaction_type, such as payment_result[]=2&payment_result[]=3.

payment_result

Allowed:

order_type

array of strings

One or more types of the order the payment belongs to. Accepts the same forms as transaction_type, such as order_type[]=single_payment&order_type[]=metered. An unrecognised value matches nothing.

order_type

Allowed:

payment_type

string

enum

initial for each order's first payment, repeated for later ones. One value only. Lower case only: any other value, including the label Initial, is ignored, and you get every payment.

Allowed:

currency

array of strings

One or more currency codes, such as EUR. Accepts the same forms as transaction_type, such as currency[]=EUR&currency[]=GBP.

currency

date_from

date

Payments processed on or after this date, such as 2026-09-01. A date that can't be read is ignored, so the results aren't narrowed.

date_to

date

Payments processed on or before this date, such as 2026-09-30. The whole day is included. A date that can't be read is ignored.

page

integer

Defaults to 1

Page number, starting at 1. A page past the last one returns 404, so stop when next_page is null. Send a positive whole number: 0, negative or non-numeric values return 500.

items

integer

≤ 100

Defaults to 20

Payments per page. Default 20. Values above 100 are reduced to 100. Other invalid values use 20.

Responses

200Success.

401Missing or invalid token.

403You're not a member of this profile.

404The page is past the last one.