Skip to main content
GET
/
v2
/
payment
/
payment_attempts
/
{id}
Retrieve a PaymentAttempt
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment/payment_attempts/{id} \
  --header 'x-auth-token: <api-key>' \
  --header 'x-client-id: <x-client-id>'
{
  "attempt_id": "24fc62b4-90d1-42e3-96ab-dd54ccc648b3",
  "amount": "9.98",
  "currency": "SGD",
  "captured_amount": "0.00",
  "refunded_amount": "0.00",
  "create_time": "2025-03-21T17:17:32+08:00",
  "update_time": "2025-03-21T17:17:32+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": {
    "cvv_result": "M",
    "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": {
    "type": "card",
    "card": {
      "card_name": "john doe",
      "card_number": "541333******4047",
      "network": "visa",
      "authorization_type": "authorization",
      "brand": "visa",
      "bin": "541333",
      "last4": "4047",
      "card_type": "credit",
      "expiry_month": "12",
      "expiry_year": "2027",
      "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "address": {
          "country_code": "SG",
          "city": "Singapore",
          "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
          "postcode": "924011",
          "state": ""
        },
        "phone_number": "12025550123"
      },
      "auto_capture": true
    }
  },
  "failure_code": "",
  "attempt_status": "INITIATED"
}

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

Path Parameters

​
id
string
required

The ID of the payment attempt to retrieve

Example:

"PA1234567890123456789"

Response

Payment attempt details retrieved successfully

​
attempt_id
string
required

Unique identifier for the attempt.

Example:

"24fc62b4-90d1-42e3-96ab-dd54ccc648b3"

​
amount
string
required

Amount of the PaymentAttempt.

Example:

"9.98"

​
currency
string
required

Three-letter currency code

Example:

"SGD"

​
captured_amount
string

Captured amount.

Example:

"0.00"

​
refunded_amount
string

Refunded amount.

Example:

"0.00"

​
create_time
string<date/time>

The time at which this PaymentAttempt was created.

Example:

"2025-03-21T17:17:32+08:00"

​
update_time
string<date/time>

Last time at which this PaymentAttempt was updated or operated on.

Example:

"2025-03-21T17:17:32+08:00"

​
complete_time
string<date/time>

Time at which this PaymentAttempt was completed.

Example:

"2024-03-01T00:00:00+08:00"

​
cancellation_reason
string

Reason for canceling this PaymentIntent.

Example:

"Order cancelled"

​
auth_code
string

Authorization code returned by the issuer upon successful authorization.

Example:

"A12B3C"

​
arn
string

Acquirer Reference Number (ARN). A 23-digit identifier used for cross-institution reconciliation and chargeback tracking.

Example:

"74537604221222132710572"

​
rrn
string

Retrieval Reference Number (RRN). A 12-digit identifier used for transaction lookup and customer service queries.

Example:

"123456789012"

​
advice_code
enum<string>

Issuer advice code indicating the recommended action after a decline. Helps merchants implement intelligent retry strategies.

Available options:
01,
02,
03,
21,
85
Example:

"01"

​
authentication_data
object

Authentication and verification data for this payment attempt.

​
payment_method
card · object

The payment method details used for this PaymentAttempt.

​
failure_code
string

PaymentAttempt failure code. Possible values are defined in Error Code Reference.payment_error section.

Example:

""

​
attempt_status
enum<string>

The status of the attempt.

  • INITIATED: The payment attempt has been created based on the initial request.
  • AUTHENTICATION_REDIRECTED: Waiting for the customer to complete identity verification, such as 3D Secure or QR code scanning.
  • PENDING_AUTHORIZATION: The authorization request has been received and is pending a final decision from the payment provider.
  • AUTHORIZED: The authorization has been successfully completed. Payment will be captured automatically or manually depending on configuration.
  • CAPTURE_REQUESTED: The capture request has been submitted successfully, and the payment is considered complete.
  • SETTLED: Funds have been settled from the payment provider and received by UQPAY.
  • SUCCEEDED: UQPAY has settled funds to your wallet.
  • CANCELLED: The payment attempt has been cancelled. Any authorized funds, if applicable, will be returned to the customer.
  • EXPIRED: The payment attempt was not completed within the allowed time window and has expired.
  • FAILED: The payment attempt has failed. Please create a new PaymentAttempt to retry.
Available options:
INITIATED,
AUTHENTICATION_REDIRECTED,
PENDING_AUTHORIZATION,
AUTHORIZED,
CAPTURE_REQUESTED,
SETTLED,
SUCCEEDED,
CANCELLED,
EXPIRED,
FAILED
Example:

"INITIATED"