The Payment Object

Represents a payment created after generating a checkout session for a customer.

This object represents the payment created after generating the checkout session for a customer. To refund a payment, see Refunds and the Refund Payment API.

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

id · string

The unique identifier of the payment (UUID, MAX 64; MIN 36).

Example: 8546df3a-b83e-4bb5-a4b3-57aa6385924f

account_id · string

The unique identifier of the account (UUID, MAX 64; MIN 36).

Example: 9104911d-5df9-429e-8488-ad41abea1a4b

description · string

The description of the payment (MAX 255; MIN 3).

Example: Purchase on web

country · string

The country where the payment takes place. ISO 3166-1 alpha-2 code.

Example: BR

merchant_order_id · string

The merchant’s unique order identifier used for reconciliation.

Example: order-20260301-001

checkout_session · string

The checkout session identifier used to create this payment.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

status · string

Current 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, CHARGEBACK

Example: SUCCEEDED

sub_status · string

Provider-level status detail that provides more granular information about the payment state.

Example: PENDING_PROVIDER_CONFIRMATION

amount · object

The payment amount details.

Show amount

value · number

The payment amount value.

Example: 100.50

currency · string

ISO 4217 currency code.

Example: BRL

customer_id · string

ID of the associated customer record. Links to the Customer Object.

Example: c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f

payment_method · object

Details about the payment method used.

Show payment_method

type · string

The payment method type.

Values: CARD, PIX, BOLETO, OXXO, PSE, BANK_TRANSFER, WALLET, BNPL

Example: CARD

vaulted_token · string

Token reference if the card is enrolled/vaulted.

Example: vtok_9f8e7d6c-5b4a-3210-fedc-ba9876543210

card · object

Card-specific details (present when type is CARD).

Show card

first_six · string

First six digits of the card number (BIN).

last_four · string

Last four digits of the card number.

brand · string

Card brand. Values: VISA, MASTERCARD, AMEX, DINERS, ELO, DISCOVER

type · string

Card type. Values: CREDIT, DEBIT, PREPAID

issuer_name · string

Name of the issuing bank.

country · string

Card issuer country (ISO 3166-1 alpha-2).

provider · object

Information about the payment provider that processed the payment.

Show provider

id · string

Yuno’s identifier for the provider connection.

name · string

Provider name (e.g., ADYEN, STRIPE, MERCADOPAGO).

transaction_id · string

The provider’s own transaction identifier.

transactions · array

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.

Show transaction object

id · string

Transaction identifier.

type · string

Transaction type. Values: PURCHASE, AUTHORIZE, CAPTURE, CANCEL, REFUND, VERIFY, CHARGEBACK, FRAUD_SCREENING, SALE

status · string

Transaction status. Values: CREATED, SUCCEEDED, PENDING, DECLINED, REJECTED, FAILED, CANCELLED, EXPIRED, ERROR, WON, LOST

provider · string

Provider that processed this attempt.

provider_transaction_id · string

Provider’s own transaction reference.

response_code · string

Provider response code. See Response Codes.

response_message · string

Human-readable response message from the provider.

created_at · string

ISO 8601 timestamp.

refunds · array

Refund records associated with this payment.

Show refund object

id · string

Refund identifier.

status · string

Refund status. Values: PENDING, SUCCEEDED, DECLINED, ERROR

amount · object

Refund amount (value + currency).

reason · string

Reason for the refund.

created_at · string

ISO 8601 timestamp.

three_ds · object

3DS authentication details, present for card payments. See 3D Secure.

Show three_ds

version · string

3DS version used (1.0, 2.1, 2.2).

eci · string

Electronic Commerce Indicator. See ECI Indicators.

status · string

Authentication status. Values: AUTHENTICATED, ATTEMPTED, FAILED, REJECTED, UNAVAILABLE

flow · string

Whether the flow was FRICTIONLESS or CHALLENGE.

installments · object

Installment details if payment was split into installments.

Show installments

quantity · integer

Number of installments.

type · string

Installment type. Values: MERCHANT, PROVIDER

failure_reason · object

Decline details when status is DECLINED or REJECTED.

Show failure_reason

code · string

Yuno error code.

message · string

Human-readable decline reason.

provider_code · string

Raw code from the provider.

merchant_advisory_code · string

MAC code when available. See Response Codes.

metadata · object

Custom key-value pairs set by the merchant. Up to 50 keys, each key max 40 characters, each value max 500 characters.

created_at · string

ISO 8601 timestamp of when the payment was created.

Example: 2026-03-01T14:31:00.000Z

updated_at · string

ISO 8601 timestamp of the last payment update.

Example: 2026-03-01T14:31:02.000Z

Example

{
  "id": "8546df3a-b83e-4bb5-a4b3-57aa6385924f",
  "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
  "description": "Purchase on web",
  "country": "US",
  "merchant_order_id": "order-20260301-001",
  "checkout_session": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "SUCCEEDED",
  "sub_status": null,
  "amount": {
    "value": 100.50,
    "currency": "USD"
  },
  "customer_id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "payment_method": {
    "type": "CARD",
    "vaulted_token": "vtok_9f8e7d6c-5b4a-3210-fedc-ba9876543210",
    "card": {
      "first_six": "411111",
      "last_four": "1111",
      "brand": "VISA",
      "type": "CREDIT",
      "issuer_name": "Chase",
      "country": "US"
    }
  },
  "provider": {
    "id": "conn_abc123",
    "name": "ADYEN",
    "transaction_id": "8835562831897070"
  },
  "transactions": [
    {
      "id": "txn_f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "type": "PURCHASE",
      "status": "SUCCEEDED",
      "provider": "ADYEN",
      "provider_transaction_id": "8835562831897070",
      "response_code": "00",
      "response_message": "Approved",
      "created_at": "2026-03-01T14:31:01.000Z"
    }
  ],
  "refunds": [],
  "three_ds": {
    "version": "2.2",
    "eci": "05",
    "status": "AUTHENTICATED",
    "flow": "FRICTIONLESS"
  },
  "installments": null,
  "failure_reason": null,
  "metadata": {
    "internal_ref": "abc-123"
  },
  "created_at": "2026-03-01T14:31:00.000Z",
  "updated_at": "2026-03-01T14:31:02.000Z"
}

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