Retrieve a PaymentIntent
Retrieves the details of a specific payment intent
Authorizations
The API token for login provided by UQPay.
Headers
The API client id generated by UQPAY
Path Parameters
The unique ID of a payment intent.
"PI1925112193204883441"
Response
Payment intent retrieved successfully
Unique identifier for the PaymentIntent
36"b1c2d3e4-f5a6-b7c8-d9e0-f1a2b3c4d5e6"
Payment amount. This is the order amount you would like to charge your customer.
"10.12"
Three-letter currency code
"SGD"
Status of this PaymentIntent.
REQUIRES_PAYMENT_METHOD: The PaymentIntent is waiting for the confirm request.REQUIRES_CUSTOMER_ACTION: The PaymentIntent is waiting for further customer action of authentication, e.g. 3DS verification and QR code scan. Please check thenext_action.REQUIRES_CAPTURE: The PaymentIntent is waiting for your capture to complete the payment.PENDING: The PaymentIntent is pending the final result from the provider. No further action is required.SUCCEEDED: The PaymentIntent has succeeded. The payment is complete.CANCELLED: The PaymentIntent has been canceled by your request. The payment is closed.FAILED: The PaymentIntent has failed.
REQUIRES_PAYMENT_METHOD, REQUIRES_CUSTOMER_ACTION, REQUIRES_CAPTURE, PENDING, SUCCEEDED, CANCELLED, FAILED Descriptor while creating a PaymentIntent.
255Available payment method types for this PaymentIntent.
Amount that captured from this PaymentIntent.
"10.12"
Snapshot of the customer associated with this PaymentIntent. Returned when customer or customer_id was supplied at creation time. The customer's unique identifier is exposed at the top level as customer_id; the id field is not included inside this object.
ID of the customer associated with this PaymentIntent. Empty for guest checkout.
36"cus_asyknf3wlfxhs1s6plamk80i8v"
Last time at which this PaymentIntent was cancelled. Only present when the PaymentIntent was successfully cancelled, i.e. status is CANCELLED.
"2024-03-01T00:00:00+08:00"
Reason for canceling this PaymentIntent.
"Order cancelled"
PaymentIntent's client secret for browser or app. Returned by PaymentIntent create API or PaymentIntent retrieve API. The provided client_secret is valid for 60 minutes.
"eyJhbGciOiJI***********ujNdZ1DF9CqWEfF1jphxI"
The merchant reference id created in merchant's system that corresponds to this PaymentIntent
36"1bf70d90-9ed0-48ce-9370-9bd7ef6ab9ee"
Any key-value object. Max length = 512 bytes. This must be valid JSON data.
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
The web page URL or application scheme URI to redirect the customer after payment authentication.
"https://127.0.0.1:8080/api/v1/callback"
Time at which this PaymentIntent was created.
"2024-03-01T00:00:00+08:00"
Time at which this PaymentIntent reached its final state.
"2024-03-01T00:00:00+08:00"
Last time at which this PaymentIntent was updated or operated on.
"2024-03-01T00:00:00+08:00"
Latest PaymentAttempt that was created under the PaymentIntent.

