Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Payment Attempts

List all PaymentAttempts

Retrieve a list of payment attempts with optional filtering

get/v2/payment/payment_attempts

Query parameters

page_sizeinteger required
Example:10

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

page_numberinteger required
Example:1

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

payment_intent_idstring
Example:PI1234567890123456789

Filter payment attempts by payment intent ID

attempt_status'INITIATED' | 'AUTHENTICATION_REDIRECTED' | 'PENDING_AUTHORIZATION' | 'AUTHORIZED' | 'CAPTURE_REQUESTED' | 'SETTLED' | 'SUCCEEDED' | 'CANCELLED' | 'EXPIRED' | 'FAILED'
Example:INITIATED

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.

Headers

x-client-idstring required

The API client id generated by UQPAY

Response

List of payment attempts retrieved successfully

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "attempt_id": "24fc62b4-90d1-42e3-96ab-dd54ccc648b3",
      "create_time": "2024-03-01T00:00:00+08:00",
      "update_time": "2024-03-01T00:00:00+08:00",
      "complete_time": "2024-03-01T00:00:00+08:00",
      "cancellation_reason": "Order cancelled",
      "auth_code": "A12B3C",
      "arn": "74537604221222132710572",
      "rrn": "123456789012",
      "advice_code": "01",
      "authentication_data": {
        "avs_result": "Y",
        "three_ds": {
          "three_ds_version": "2.2.0",
          "eci": "05",
          "cavv": "AAABCZIhcQAAAABZlyFxAAAAAAA=",
          "three_ds_authentication_status": "Y",
          "three_ds_cancellation_reason": "01"
        }
      },
      "payment_method": {
        "card": {
          "card_name": "john doe",
          "card_number": "541333******4047",
          "brand": "visa",
          "bin": "541333",
          "last4": "4047",
          "expiry_month": "12",
          "expiry_year": "2027",
          "billing": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "phone_number": "12025550123",
            "address": {
              "country_code": "SG",
              "city": "Singapore",
              "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
              "postcode": "924011"
            }
          }
        }
      },
      "attempt_status": "INITIATED"
    }
  ]
}