TheDocumentation Index
Fetch the complete documentation index at: https://docs.paymend.com/llms.txt
Use this file to discover all available pages before exploring further.
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
| Field | Type | Description |
|---|---|---|
paymentId | string | Unique identifier for the payment generated by the system (up to 32 char.) |
merchantReference | string | Reference passed in by the merchant for correlation |
amount | integer | Amount processed in the smallest currency unit |
currency | string | ISO 4217 currency code used in the payment |
status | string | Current 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” |
failure | object | Details about the cause of a failed payment (only present if status is FAILED) |
paymentMethod | object | The chosen payment method details (e.g., card) |
captureNow | boolean | Determines how the payment is processed. Default: false → Authorization only (funds reserved, must capture later). If true → Sale (authorize and capture in one step) |
descriptor | string | Text shown on the customer’s bank statement (e.g., merchant or product name) |
goodsType | string | Type of goods being purchased: PHYSICAL = tangible items, DIGITAL = non-physical items, MIXED = combination of both |
source | object | Details related to where a payment originated |
productItems | array | List of product or service items included in this payment. Each item is a ProductItem object |
consumer | object | Consumer details such as name, email, phone |
billing | object | Billing address information |
shipping | object | Shipping address and recipient details |
transactions | array of Transaction | Optional array with details of all transactions processed for a payment. Provided when the payment is not in PENDING state. |
createdAt | string | Timestamp when the payment was created |
updatedAt | string | Timestamp when the payment was last updated |