Retrieve a payment intent

This API endpoint returns information about a payment intent based on the id of the payment intent.

Related guide(s): Payment intent ID and Capture method

Successful response payload data

Parameter nameTypeDescription
idstringThe ID of the payment intent.

More information can be found in the Payment intent ID page.
amountstringThe total amount of all items after discounts and taxes.
succeededAmountstringThe total amount processed.
refundedAmountstringThe total amount refunded.
capturebooleanAn identifier to see if the transaction is a captured transaction.

More information can be found in the capture method page.
currencystringThe three-letter ISO currency code of the payment.

Currently, only supports MYR.
referenceIdstringThe partner’s generated ID, which generated this transaction.
paymentMethodobjectThe payment method for this session.
paymentMethod.familystringThe family the payment method belongs to.
paymentMethod.typestringThe payment method type.
paymentMethod.brandstringThe payment method brand.
referenceMetaobjectAn object to store additional information about the transaction (e.g: order details, etc.).
referenceMeta.items.itemNamestringName and description of the item.
referenceMeta.items.variationNamestringItem variation.
E.g: M, Red.
referenceMeta.items.unitPricefloatThe price per item.
referenceMeta.items.quantityintegerThe number of items purchased.
referenceMeta.items.totalPricefloatTotal price = item quantity x item unit price
referenceMeta.items.totalDiscountedPricefloatThe total price after discount.
referenceMeta.totalDiscountfloatThe total amount of discount given.
referenceMeta.subtotalfloatThe total amount before applying any taxes or discount, fee, etc.
referenceMeta.shippingFeefloatThe shipping fee (applicable for e-commerce).
referenceMeta.pumpNumberstringThe code for the pump being operated.
referenceMeta.stationNamestringThe name of the station where the operating pump is located.
subMerchantobject⚠️Required for third party acquirers
Partners' merchant information (lowest level merchant).

This will be used to display on our checkout page and e-receipt.
subMerchant.namestringThe name of partners' merchant.
subMerchant.referencestringThe partner's merchant's ID provided by partners.
statusstringThe current status of the payment intent.

The full list of statuses can be found in the Payment intent status page.
refundedReasonstringThe reason for the refund.
createdAtdate stringThe time the payment intent was created.
updatedAtdate stringThe time the payment intent was last updated.
Language
Credentials
Click Try It! to start a request and see the response here!