Skip to main content
The PaymentResponse object contains the result of any payment operation (payment, refund, or void), including the payment status, transaction history, and any relevant details such as consumer, billing, shipping, product items, and payment method information. This unified model is used across all payment-related endpoints.

Properties

FieldTypeDescription
paymentIdstringUnique identifier for the payment generated by the system (up to 32 char.)
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”
failureobjectDetails about the cause of a failed payment (only present if status is FAILED)
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
sourceobjectDetails related to where a payment originated
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
transactionsarray of TransactionOptional array with details of all transactions processed for a payment. Provided when the payment is not in PENDING state.
createdAtstringTimestamp when the payment was created
updatedAtstringTimestamp when the payment was last updated