Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Payment

Get a payment by ID

Retrieves details of a specific payment by ID

get/api/payment/{paymentId}

Path parameters

paymentIdstring required
Example:paymentId_1234567890abcdef

Unique identifier of the payment

Response

Get a payment by ID successful

idstring required

The id of the payment

amountnumber required

The amount of the payment in cents, this has been calculated from the products prices and quantities

customerEmailstring required

The email of the customer

customerIdstring nullable

The id of the customer

currency'EUR' | 'GBP' | 'USD' required

The currency of the payment, this currency will refer to product list prices

metadatasobject

The metadatas of the payment

status'INITIATION' | 'CHECKOUT_PENDING' | 'CHECKOUT_AUTHORIZED' | 'CHECKOUT_SUCCESS' | 'CHECKOUT_CANCELED' | 'CANCELED' | 'PAYMENT_RECEIVED' | 'PAYMENT_SUCCESS' | 'PAYMENT_FAILED' | 'PARTIAL_REFUNDED' | 'FULLY_REFUNDED' | 'REFUND_PENDING' | 'REFUND_FAILED' | 'DISPUTE_INQUIRY' | 'DISPUTE_INQUIRY_CLOSED' | 'DISPUTE_OPENED' | 'DISPUTE_EVIDENCE_SUBMITTED' | 'DISPUTE_UNDER_REVIEW' | 'DISPUTE_WON' | 'DISPUTE_LOST' | 'DISPUTE_ACCEPTED' | 'DISPUTE_PREVENTED' | 'FRAUD_FLAGGED' required

The status of the payment, exhaustive list of status to come

captureMode'AUTOMATIC' | 'MANUAL' required

AUTOMATIC or MANUAL (authorize now, capture later)

authorizedAtstring date-time nullable
capturedAmountInCentsnumber required

Total amount captured in cents (TTC)

createdAtstring date-time required

The creation date of the payment

updatedAtstring date-time required

The last update date of the payment

subscriptionIdstring nullable

The subscription id if payment is part of a subscription

taxCountrystring nullable

The tax country of the payment

amountTaxesIncludednumber nullable

The total amount including taxes in cents

depositStatusstring nullable

The status from the deposit payment service provider

taxRateInPercentagenumber nullable

The tax rate in percentage applied to the payment

pricingModestring nullable

The pricing mode used for the payment. TAX_EXCLUSIVE (default): Prices are excluding tax (HT), tax is added on top. TAX_INCLUSIVE: Prices include tax (TTC), tax is extracted from total.

expiresAtstring date-time nullable

The expiration date of the payment

invoiceUrlstring nullable

URL to view and download the invoice (available after payment success)

Example response

{
  "lastDepositAttempt": {
    "status": "succeeded",
    "amount": 10000,
    "paymentMethod": "CARD",
    "error": "card_declined",
    "attemptedAt": "2025-10-24T14:35:00Z"
  },
  "taxRateInPercentage": 20,
  "pricingMode": "TAX_EXCLUSIVE",
  "lastThreeDsAttempt": {
    "status": "succeeded",
    "cardBrand": "Visa",
    "createdDate": "2025-11-12T21:51:33.530Z"
  },
  "invoiceUrl": "https://api.inflowpay.com/invoice/download?token=abc123xyz",
  "customerPaymentMethod": {
    "id": "cpm_abc123",
    "type": "card",
    "cardBrand": "visa",
    "cardLast4": "4242"
  }
}