Metadata and routing logic. For routing logic to work correctly, metadata must also be set at the Checkout Session level. Setting it only on the Payment object will not trigger route logic.
Object Fields
The unique identifier of the payment (UUID, MAX 64; MIN 36).Example:
8546df3a-b83e-4bb5-a4b3-57aa6385924fThe unique identifier of the account (UUID, MAX 64; MIN 36).Example:
9104911d-5df9-429e-8488-ad41abea1a4bThe description of the payment (MAX 255; MIN 3).Example:
Purchase on webThe country where the payment takes place. ISO 3166-1 alpha-2 code.Example:
BRThe merchant’s unique order identifier used for reconciliation.Example:
order-20260301-001The checkout session identifier used to create this payment.Example:
a1b2c3d4-e5f6-7890-abcd-ef1234567890Current payment status. See Payment Statuses for the complete lifecycle.Values:
CREATED, PENDING, AUTHORIZED, IN_PROCESS, SUCCEEDED, PARTIALLY_APPROVED, CAPTURED, PARTIALLY_CAPTURED, DECLINED, REJECTED, CANCELLED, EXPIRED, REFUNDED, PARTIALLY_REFUNDED, IN_DISPUTE, CHARGEBACKExample: SUCCEEDEDProvider-level status detail that provides more granular information about the payment state.Example:
PENDING_PROVIDER_CONFIRMATIONThe payment amount details.
ID of the associated customer record. Links to the Customer Object.Example:
c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4fDetails about the payment method used.
Information about the payment provider that processed the payment.
Individual processing attempts for this payment. A payment may have multiple transactions if the first provider declines and Yuno routes to an alternative. See Transactions.
Refund records associated with this payment.
Installment details if payment was split into installments.
Decline details when status is
DECLINED or REJECTED.Custom key-value pairs set by the merchant. Up to 50 keys, each key max 40 characters, each value max 500 characters.
ISO 8601 timestamp of when the payment was created.Example:
2026-03-01T14:31:00.000ZISO 8601 timestamp of the last payment update.Example:
2026-03-01T14:31:02.000ZExample
Related Endpoints
- Create Payment.
POST /v1/payments - Get Payment.
GET /v1/payments/{payment_id} - Get Payment by Merchant Order.
GET /v1/payments?merchant_order_id={id} - Capture Payment.
POST /v1/payments/{payment_id}/transactions/{transaction_id}/capture - Cancel Payment.
POST /v1/payments/{payment_id}/cancel - Refund Payment.
POST /v1/payments/{payment_id}/refund - Cancel or Refund.
POST /v1/payments/{payment_id}/cancel-or-refund
Related Concepts
- Payment Statuses. Status lifecycle and transition diagram
- Transactions. How transactions relate to payments
- Response Codes. MAC codes and provider error mapping