API Reference
  1. Invoices

List invoice payment attempts

get
https://api-dev.gettrx.com/onboard/v1/invoices//invoice-payment-attempts

Lists payment attempts for an invoice with keyset pagination. Data is loaded from the relational database via customer-payment-management-service. Results are sorted by created descending (newest first). Payment methods are expanded by default when stored in DynamoDB. Decoded pagination token: cdt:<epoch>|id:<payment_attempt_id> (invpayattempt_...).

Path Params
string
required
length between 10 and 128

Invoice ID the payment attempts belong to.

Query Params
int32
Defaults to 10

Number of records per page (1–100, default 10)

string

Base64-encoded keyset cursor. Decoded format: cdt:<created_timestamp>|id:<payment_attempt_id>

string

Sort order. Only created:desc is supported (default when omitted).

Headers
string
required

Secret key associated to the partner's account

string

(Optional) AccountId of the merchant. Only required when secretKey belongs to an "entity" account.

string

Unique Key String refNumber

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?