After creating a payment, retrieve its status, refresh it from the provider, or find payments using filters. All operations are scoped to the authenticated merchant.
List Payments
Lists the authenticated merchant's payments, newest first. Combine the parameters below to apply all filters before pagination.
Find payments by reference
Pass the PPR webhook's refPagamento as search. Search uses a substring match and preserves leading zeros. Compare the returned reference with the full value when you need an exact match.
bash
Filter by status and date
bash
Dates filter payment creation time with inclusive boundaries. Use status=Failed for payment records marked failed. Bank rejections can be retrieved through GET /api/references/ppr/{reference}/attempts?status=Failed when attempt tracking is enabled.
Pagination and PPR Charging
The response includes data, pageNumber, pageSize, totalItems, and totalPages. Totals reflect the filters. Keep the same filters as you advance pages. A search with no matches returns data: [].
Charging references remain reusable after a collection. This list excludes the parent record and returns individual payments. Read each item's status and use its internalId in GET /api/payments/{paymentId}. Example values are fictional.
query Parameters
pageNumberPage number.
pageSizeRecords per page.
statusPayment status. Omit to include all statuses.
paymentTypePayment type.
startDateInclusive lower bound on payment creation time. Send an ISO 8601 UTC timestamp.
endDateInclusive upper bound on payment creation time. Send an ISO 8601 UTC timestamp.
searchSubstring match on the payment reference. Use the full reference and compare the returned reference when an exact match is needed.
List Payments › Responses
Paged payments.
Get Payment Details
Method and route: GET /api/payments/{paymentId}. Retrieves the current details of a payment.
Use the payment's id or internalId. For PPR Charging, use the internalId of the individual payment from the payments list. A bare PPR reference may resolve to a single record if it equals the stored connector ID. The UUID returned as id by the compact PPR creation response identifies the reference record.
path Parameters
paymentIdExternal payment identifier.
Get Payment Details › Responses
Payment details.
idinternalIdmerchantIdreferenceamountcurrencypaymentTypestatuscreatedAtcompletedAtdescriptioncustomerEmailcustomerNamecustomerTelephonedocumentNumberA merchant-defined JSON object for linking an IZI Pay payment to records in your own systems.
Property names are chosen by the merchant; the example keys are illustrative and are not a fixed list. Each property may contain a JSON string, number, boolean, array, nested object, or null. Key spelling and casing are preserved.
IZI Pay stores these values without using them to control payment processing. They are returned as customMetadata by payment creation/detail/list and PPR creation/detail/list responses.
Use this object for internal identifiers such as invoice numbers, purchase orders, departments, customer codes, or source-system references. Do not include passwords, access tokens, card details, or other secrets.
Sync Payment Status
Queue a background refresh of this merchant’s payment status from the provider. Use the payment’s internalId (or provider payment ID) in the path. HTTP 202 Accepted means the refresh was queued; it does not contain a new payment status. Call GET /api/payments/{paymentId} afterward to read the latest stored result.
path Parameters
paymentIdExternal payment identifier.
Sync Payment Status › Responses
Refresh queued. Empty response body.