Skip to main content
This object represents the payment created after generating the checkout session for a customer. To refund a payment, see Refund payments and the Refund payment API.
Metadata and routing logicFor 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.
id
string
The unique identifier of the customer (MAX 64 ; MIN 36).Example: 8546df3a-b83e-4bb5-a4b3-57aa6385924f
account_id
string
The unique identifier of the account (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
enum
Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1 ).Possible enum values: Check the Country reference.
status
enum
The status of the transaction.Example: SUCCEEDED
sub_status
enum
It is a complement to the status information.Example: DECLINED
merchant_order_id
string
The unique identifier of the customer’s order (MAX 255; MIN 3).Example: 0000023
created_at
timestamp
The date and time when the payment was created.Example: 2022-05-09T20:46:54.786342Z
updated_at
timestamp
The date and time of last update for the payment.Example: 2022-05-09T20:46:54.786342Z
idempotency_key
string
optionalThe idempotency key sent when creating the payment; present when the payment was created with an idempotency key.Example: fc0d89a1-8d18-4759-8d0a-ee1c6d0386e2
account_code
string
optionalThe account code associated with the payment (account identifier).Example: 26a6626c-d3ec-4caa-bf7c-a994b145dc00
optionalPresent when the payment was created via a payment link; identifies the payment link used.Example: (empty string when not from a payment link)
subscription_code
string | null
optionalPresent when the payment is associated with a subscription; the subscription identifier.Example: null
simplified_mode
boolean
optionalIndicates whether the payment was created in simplified mode (e.g. for certain flows such as subscription or retry).Example: false
amount
object
Specifies the payment amount object, with the value and currency.
checkout
object
Specifies the checkout object. This object is not mandatory for back to back payments. Required when WORKFLOW is defined as CHECKOUT or is not sent. Not required for DIRECT payments.
metadata
array of objects
Specifies a list of custom key–value pairs associated with the payment (for internal references, segmentation, or workflow tags). You can add up to 120 metadata objects.
payment_method
object
Specifies the payment_method object.
customer_payer
object
Specifies customer object for payments.
additional_data
object
Specifies the additional_data object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.
transactions
object
Specifies the transaction details associated with a payment.
split_marketplace
array of objects
Split marketplace array of objects
transactions_history
array of objects
The list of the transactions that are part of a payment. It is going to depend on how many providers you have set up in your payment method route.
workflow
enum
The payment workflow. Indicates whether the integration will use Yuno´s SDK or will be a back to back connection (Card implementation only available for PCI compliant merchants).Possible enum values:
  • SDK_CHECKOUT: Use Yuno SDK.
  • DIRECT: Back to back integration with provider info for custom payment experience.
  • REDIRECT: Back to back integration with provider redirection.
callback_url
string
The URL where to redirect the customer after the payment. Only required for DIRECT integrations that have a redirection (MAX 526; MIN 3).Example: https://www.company.com/customer_1231324
metadata
array of objects
Specifies a list of custom key–value pairs associated with the payment (for internal references, segmentation, or workflow tags). You can add up to 120 metadata objects.
routing_rules
array of objects
Returns the routing rules information during the payment creation.
subscription_id
string
The unique identifier of the subscription associated to the payment (MAX 64 ; MIN 36).Example: 7304911d-5df9-429e-8488-ad41abea1a4c
subscription
struct
Returns the subscription details associated to the payment.
fraud_screening
array of objects
Provides information about the fraud scans used for the payment.