Skip to main content
The PaymentResponse object contains the result of any payment operation (payment, refund, or void), including the payment status and any relevant details. This unified model is used across all payment-related endpoints.

Properties

FieldTypeDescription
paymentIdstringUnique identifier for the payment generated by the system
merchantReferencestringReference passed in by the merchant for correlation
amountintegerAmount processed in the smallest currency unit
currencystringISO 4217 currency code used in the payment
statusstringCurrent state of the payment. See Statuses for detailed descriptions of each status value. For refunds, this will be “REFUNDED”; for voids, this will be “VOIDED”
paymentMethodobjectThe chosen payment method details (e.g., card)
captureNowbooleanDetermines how the payment is processed. Default: false → Authorization only (funds reserved, must capture later). If true → Sale (authorize and capture in one step)
descriptorstringText shown on the customer’s bank statement (e.g., merchant or product name)
goodsTypestringType of goods being purchased: PHYSICAL = tangible items, DIGITAL = non-physical items, MIXED = combination of both
productItemsarrayList of product or service items included in this payment. Each item is a ProductItem object
consumerobjectConsumer details such as name, email, phone
billingobjectBilling address information
shippingobjectShipping address and recipient details
createdAtstringTimestamp when the payment was created
updatedAtstringTimestamp when the payment was last updated
failureCodestringCode indicating the reason for failure (only present if status is FAILED)
failureMessagestringHuman-readable explanation of the failure (only present if status is FAILED)