Skip to main content
GET
List all PaymentAttempts

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-client-id
string
required

The API client id generated by UQPAY

Query Parameters

page_size
integer
required

The maximum number of items to return per page. This number can be between 1 - 100

Required range: 1 <= x <= 100
Example:

10

page_number
integer
required

The page number to retrieve the next set of items. The number has to be greater than 1.

Required range: x >= 1
Example:

1

payment_intent_id
string

Filter payment attempts by payment intent ID

Example:

"PI1234567890123456789"

attempt_status
enum<string>

Filter payment attempts by status.

  • INITIATED: Created based on the initial request.
  • AUTHENTICATION_REDIRECTED: Waiting for customer identity verification.
  • PENDING_AUTHORIZATION: Pending a final decision from the payment provider.
  • AUTHORIZED: Authorization successfully completed.
  • CAPTURE_REQUESTED: Capture submitted, payment is considered complete.
  • SETTLED: Funds settled from payment provider and received by UQPAY.
  • SUCCEEDED: UQPAY has settled funds to your wallet.
  • CANCELLED: The payment attempt has been cancelled.
  • EXPIRED: Not completed within the allowed time window.
  • FAILED: The payment attempt has failed.
Available options:
INITIATED,
AUTHENTICATION_REDIRECTED,
PENDING_AUTHORIZATION,
AUTHORIZED,
CAPTURE_REQUESTED,
SETTLED,
SUCCEEDED,
CANCELLED,
EXPIRED,
FAILED
Example:

"INITIATED"

Response

200 - application/json

List of payment attempts retrieved successfully

total_pages
integer

The total pages of available items.

Example:

10

total_items
integer

The total counts of available items.

Example:

105

data
object[]