latestOpenAPI 3.0.32026-08-215925112.0 MB
36be0dca14e7
api
payments
Get a Payment
get/api/payments/{id}
Path parameters
idstring required
The ID of the payment
The ID of the payment
Response
OK
_idstring required
The ID of the payment
amountnumber required
The amount of the payment
currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' required
An ISO 4217 3-character code of the currency
status'SCHEDULED' | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'REFUNDED' required
The status of the payment
checkoutIdstring
The ID of the checkout the payment belongs to
transactionIdstring
The ID of the transaction the payment belongs to
paymentRequestIdstring required
The ID of the payment request the payment belongs to
paymentGatewayIdstring
The ID of the payment gateway responsible for the payment
referencestring
The reference of the payment
sellerIdstring required
The ID of the seller owning the payment
customerIdstring
The ID of the customer of the payment
createdAtstring date-time required
An ISO timestamp indicating when the payment was created
updatedAtstring date-time required
An ISO timestamp indicating when the payment was last updated