API v1FiatPe Home
FiatPeDocs

Payments

Use the Payments API to retrieve and track payment transactions processed through FiatPe. A payment contains details such as amount, currency, payment method, transaction ID, order reference, customer details, status, and timestamps. This API helps merchants verify payment outcomes, monitor failed or pending attempts, and reconcile successful transactions.

Entity

idstring

The unique identifier of the payment transaction.

entitystring

The type of entity represented by this object.

amountinteger

The payment amount in the smallest currency sub-unit. For example, ₹500.00 is represented as 50000.

currencystring

The three-letter ISO currency code in which the payment was processed.

statusstring

The current status of the payment transaction. Possible values include created, authorized, captured, and failed.

order_idstring | null

The unique identifier of the order associated with this payment. Returns null if the payment is not linked to an order.

methodstring

The payment method used for the transaction, such as card, upi, netbanking, or wallet.

bankstring | null

The bank used for the payment, if applicable. Returns null if bank information is not available or not applicable.

walletstring | null

The wallet used for the payment, if applicable. Returns null if the payment was not made through a wallet.

vpastring | null

The UPI VPA used for the payment, if applicable. Returns null if the payment was not made through UPI.

emailstring | null

The customer email address associated with the payment, if available.

contactstring | null

The customer contact number associated with the payment, if available.

metadatajson object

Key-value pairs used to store additional information related to the payment.

feeinteger

The transaction fee charged for processing the payment, in the smallest currency sub-unit.

taxinteger

The tax amount applicable on the transaction fee, in the smallest currency sub-unit.

error_descriptionstring

The error description for the payment, if the transaction failed. Returns an empty string when no error is available.

created_atinteger

The Unix timestamp indicating when the payment was created.