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.
optionalThe idempotency key sent when creating the payment; present when the payment was created with an idempotency key.Example: fc0d89a1-8d18-4759-8d0a-ee1c6d0386e2
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.
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.
Specifies a metadata key and the respective value.Use to attach merchant-defined context (for example: order_id, customer_tier). Avoid sending sensitive or personal data.
The vaulted_token represents a securely stored payment_method associated with a previous transaction. When
utilizing a vaulted_token for creating a payment, there is no need to send an additional token; it can be set as
null (MAX: 64; MIN: 36).This field is returned in the payment response when vault_on_success = true and the payment status is SUCCEEDED, provided the payment references an existing Yuno customer through customer_payer.id.Example: 8604911d-5ds9-229e-8468-bd41abear14s
Payment method type. Mandatory for DIRECT or REDIRECT workflow. Required when integrating wallets, even when using the SDK.Possible enum values:Possible enum values: check the payment type reference.
Flag to enroll the card after a successful payment. Requires the payment to reference an existing Yuno customer through customer_payer.id .When set to true and the payment status is SUCCEEDED, the payment response will include a vaulted_token that can be used for future transactions. Without a customer ID no vaulting occurs and no vaulted_token is returned, even if customer details are included inline.Possible values: True or False
The one time use payment method token provided by Yuno sdk . If a payment is created using a token,
it is not necessary to send a vaulted_token as well, it can be defined as null. Not necessary for back to back
payments (MAX: 64; MIN: 36).Example: 5104911d-5df9-229e-8468-bd41abea1a4s
Specifies the payment method detail object, which provides details of the different transaction category
types that are part of the payment method object.
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you to
reserve funds in a customer’s bank account.Possible values: True or False
The descriptor passed per transaction to out platform. It will be presented on the customer’s
physical bank statement (MAX 15; MIN 0).Example: COMPANY1
The unique identifier of the payment receipt assigned by the issuing bank for a card transaction.
This field is empty if the gateway does not provide information about the transaction (MAX 255; MIN 3).Example: 43564
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 41961111
When a customer enrolls a credit card multiple times related to one or many Yuno accounts, multiple vaulted_tokens will be generated, but the fingerprint lets you identify when the same card is used for the customer (MAX 255; MIN 3).Example: 55a7fe38-cdc3-45dc-8c5f-820751799c76
This field must be completed with the result of the ECI field provided by the 3d Secure
service. The Electronic Commerce Indicator (ECI) informs the card issuer if the transaction was
protected by a security protocol like VbV or MCSC. It is mandated by Visa and MasterCard that all
3-D Secure transactions have this value populated in the authorization request (MAX: 2, MIN: 0).Example: 05
This field must be completed with the result of the cryptogram field provided by the 3DSecure
service. In Visa transactions, it represents the Cardholder Authentication Verification Value
(CAVV), a cryptographic value generated by the Issuer as evidence of payment authentication during
online purchase to qualify for chargeback protection. MasterCard transactions have a similar value
called Accountholder Authentication Value (AAV) or the Universal Cardholder Authentication Field
(UCAF). When submitting a transaction for authorization, the merchant must include the CAVV or
AAV/UCAF to demonstrate that the cardholder has been authenticated. It is typically base64-encoded.
(MAX: 40, MIN: 0).Example: BA0BB1Z3N5Q4kjkBU3c3ELGUsJY =
For 3DS v1:
This is the Unique Transaction Identifier. It is automatically generated by the MPI. It is typically
28 bytes in length and base64-encoded. Is commonly referred to as XID (MAX: 40, MIN: 0).
For 3DS v2:
Universally unique transaction identifier assigned by the DS to identify a single transaction. (MAX:
36, MIN:36).Ex for V1: “TjY0MjAxRjA4MD4987DUzMzYyNjU=”
Ex for V2: “c4e59ceb-a382-4d6a-bc87-385d591fa09d”
The Institution identification number (IIN) refers to the first few digits of a network token number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
[Only required for certain providers] - In case the token has been authenticated by Mastercard the field should be set to 02. For Visa or not authenticated tokens, is not necessary to send the field.
This field lets you indicate if this is the first time the vaulted_token/network_token is used for a payment or if it has already been used for a previous payment. Enum: FIRST, USEDExample: USED
Unique identifier assigned to a transaction by the card network. It is used to track and reference specific transactions, particularly in recurring payment scenarios, ensuring consistency and traceability across the payment lifecycle (MAX 255; MIN 3).Example: 583103536844189
Payments instructions related to the payment (MAX 255; MIN 3).Example: Go to your bank account and transfer the amount using the reference detailed
below
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you to
reserve funds in a customer’s bank account.Possible values: True or False
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
Indicates the processing type of the transaction. This object is used to send additional information about recurrence. It’s optional, and few providers require it (e.g. Mercado Pago). Contact your TAM to confirm if it’s needed for your integration.
This field lets you indicate if this is the first time the vaulted_token/network_token is used for a payment or if it has already been used for a previous payment. Enum: FIRST, USEDExample: USED
Unique identifier assigned to a transaction by the card network. It is used to track and reference specific transactions, particularly in recurring payment scenarios, ensuring consistency and traceability across the payment lifecycle (MAX 255; MIN 3).Example: 583103536844189
This structure is used to send additional information about recurrence. It’s optional, and few providers require it (e.g. Mercado Pago). Contact your TAM to confirm if it’s needed for your integration.
Specifies the billing_cycles object. Defines the number of charges associated to the subscription. If using this object, you must enter data on all fields.
The start date that the subscription plan will be available to use. If not set, the subscription is available from the moment it is created. start_at becomes mandatory when using finish_at .
The end date that the subscription plan will be available to use. If not set, the subscription is available indefinitely. finish_at becomes mandatory when using start_at .
Payments instructions related to the payment (MAX 255; MIN 3).Example: Go to your closest store and pay the total amount using the reference detailed below
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you to
reserve funds in a customer’s bank account.Possible values: True or False
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
The unique identifier of the customer (MAX 64; MIN 36). 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.Example: faa89e18-5a11-11ed-9b6a-0242ac120002
The customer’s device fingerprint (MAX 4000; MIN 1). For integrations using Yuno checkout the value is
obtained automatically, do not send this field.Example: hi88287gbd8d7d782ge…
In case you are using a DIRECT integration and want to support more than one fraud provider in the payment flow, you can use this object to specify the necessary information. For integrations using Yuno checkout the value is obtained automatically, do not send this field.
The color depth of the customer’s browser in bits per pixel. This should be obtained by using the
browser’s screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth
(MAX
5; MIN 1).Example: 15
The user agent value of the customer’s browser (MAX 255; MIN 3).Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like
Gecko)
Version/9.0.2 Safari/601.3.9
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.
A running index (starts with 1), describing the order of routes by time. E.g: If an order contains 2 Routes: New-York→London→Paris (connection in London) New-York→London should have route_order=1, order=1; London→Paris should have route_order=1, order=2; Paris→London→New-York: Paris→London should have route_order=2, order=1; London→New-York should have route_order=2, order=2.Example: 1
The fare class code of the airline (MAX 1; MIN 1). The values can be a letter (A-Z) but may vary depending on the airline’s definition. Check the Airline information reference.Example: Y
The stopover code (1-letter code that indicates whether the passenger is allowed to make a
stopover.
Only two types of characters are allowed: O: Stopover allowed (the letter “O”, not zero) / X: Stopover
not
allowed).Example: O
The shipping amount of the order (multiple of 0.0001).This field is for informational purposes, the shipping amount is already included in the final transaction amount and is not added separately.Example: 5190
The fee amount of the order (multiple of 0.0001).This field is for informational purposes, the fee amount is already included in the final transaction amount and is not added separately.Example: 789.50
The tip amount of the order (multiple of 0.0001). This field is for informational purposes, the tip amount is already included in the final transaction amount and is not added separately.Example: 215.10
When true , Yuno automatically retries capture or cancel operations if they fail. Default is false . You may also see this field in delayed_capture_settings or delayed_cancel_settings . For the full retry schedule, see Transaction Retries and Cancel and Capture Flow .Example: false
Indicates whether a customer-facing receipt has been requested or generated for this transaction. When true , receipt_url may be available.Example: false
URL where you can access the generated receipt for this transaction (e.g. a PDF or hosted page). null if no receipt is available yet. Use the Retrieve Payment by ID endpoint and check this field in the payment.transaction object.Example: null
The vaulted token for a previously stored payment_method . If a payment is created using a
vaulted_token, it is not necessary to send a token as well, it can be defined as null (MAX: 64; MIN: 36).Example: 8604911d-5ds9-229e-8468-bd41abear14s
Type of the payment method. Mandatory for DIRECT or REDIRECT workflow. Required when integrating wallets, even when using the SDK.Possible enum values:Possible enum values: Check the payment type reference.
The one time use payment method token provided by Yuno sdk . If a payment is created using a
token, it is not necessary to send a vaulted_token as well, it can be defined as null. Not necessary for
back to back payments (MAX: 64; MIN: 36).Example: 5104911d-5df9-229e-8468-bd41abea1a4s
When using a wallet for payments through a direct integration , this field indicates the provider from which the card information was obtained.Example: APPLE_PAY
Specifies the payment method detail object, which provides details of the different transaction
category
types that are part of the payment method object.
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you
to
reserve funds in a customer’s bank account.Possible values: True or False
The descriptor passed per transaction to out platform. It will be presented on the customer’s
physical bank statement (MAX 15; MIN 0).Example: COMPANY1
The unique identifier of the payment receipt assigned by the issuing bank for a card
transaction.
This field is empty if the gateway does not provide information about the transaction (MAX 255; MIN
3).Example: 43564
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 41961111
The type of the card’s issuer (MAX 255; MIN 3).Example: CREDIT, DEBIT, or CHARGE_CARDfingerprint string
When a customer enrolls a credit card multiple times related to one or many Yuno accounts, multiple vaulted_tokens will be generated, but the fingerprint lets you identify when the same card is used for the customer (MAX 255; MIN 3).
Example: 55a7fe38-cdc3-45dc-8c5f-820751799c76
This field must be completed with the result of the ECI field provided by the 3d Secure
service. The Electronic Commerce Indicator (ECI) informs the card issuer if the transaction was
protected by a security protocol like VbV or MCSC. It is mandated by Visa and MasterCard that
all 3-D Secure transactions have this value populated in the authorization request (MAX: 2,
MIN: 0).Example: 04
This field must be completed with the result of the cryptogram field provided by the
3DSecure service. In Visa transactions, it represents the Cardholder Authentication Verification
Value (CAVV), a cryptographic value generated by the Issuer as evidence of payment
authentication during online purchase to qualify for chargeback protection. MasterCard
transactions have a similar value called Accountholder Authentication Value (AAV) or the
Universal Cardholder Authentication Field (UCAF). When submitting a transaction for
authorization, the merchant must include the CAVV or AAV/UCAF to demonstrate that the cardholder
has been authenticated. It is typically base64-encoded (MAX: 40, MIN: 0).Example: BA0BB1Z3N5Q4kjkBU3c3ELGUsJY =
For 3DS v1:
This is the Unique Transaction Identifier. It is automatically generated by the MPI. It is
typically 28 bytes in length and base64-encoded. Is commonly referred to as XID (MAX: 40, MIN:
0).
For 3DS v2:
Universally unique transaction identifier assigned by the DS to identify a single transaction.
(MAX: 36, MIN:36).Ex for V1: “TjY0MjAxRjA4MD4987DUzMzYyNjU=”
Ex for V2: “c4e59ceb-a382-4d6a-bc87-385d591fa09d”
Indicates the outcome of the cardholder authentication during the 3-D Secure process. It informs you whether the authentication was successful (Y), failed (N), could not be completed (U), or was only attempted (A).Example: Y
Indicates whether a 3DS challenge occurred. When false , the flow can be frictionless or data-only. Data-only is not explicitly flagged in the response.Example: false
The Institution identification number (IIN) refers to the first few digits of a network token number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
[Only required for certain providers] - In case the token has been authenticated by Mastercard the field should be set to 02. For Visa or not authenticated tokens, is not necessary to send the field.
This field Iets you indicate if this is the first time the vaulted_token/network_token is used for a payment or if it has already been used for a previous payment. Enum: FIRST, USEDExample: USED
Unique identifier assigned to a transaction by the card network. It is used to track and reference specific transactions, particularly in recurring payment scenarios, ensuring consistency and traceability across the payment lifecycle (MAX 255; MIN 3).Example: 583103536844189
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you
to
reserve funds in a customer’s bank account.Possible values: True or False
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
Payments instructions related to the payment (MAX 255; MIN 3).Example: Go to your bank account and transfer the amount using the reference detailed
below
Payments instructions related to the payment (MAX 255; MIN 3).Example: Go to your closest store and pay the total amount using the reference detailed below
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you
to
reserve funds in a customer’s bank account.Possible values: True or False
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
The reason for the transaction. Applies to secondary transactions, such as refunds or captures.Possible values: CANCELLED, DISMISS, DUPLICATE, DUPLICATED, FRAUDULENT, MISSED, NOT_FOUND, ORDER_STOPPED, REFUNDED, REQUESTED_BY_CUSTOMER, RESOLVED, REVERSE, SERVICE_SUSPENDED
The message of the international standard for financial transaction card originated interchange messaging ( ISO 8583 ).Example: Approved or completed successfully
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you
to
reserve funds in a customer’s bank account.Possible values: True or False
The descriptor passed per transaction to out platform. It will be presented on the customer’s
physical bank statement (MAX 15; MIN 0).Example: COMPANY1
The unique identifier of the payment receipt assigned by the issuing bank for a card
transaction.
This field is empty if the gateway does not provide information about the transaction (MAX 255; MIN
3).Example: 43564
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 41961111
Using amount = 0 and verify = true, you can verify the user’s card without authorizing a real
amount.Possible values: True or Falsecryptogram string
Cryptogram for direct integrations with card wallets (MAX 526; MIN 3).
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you
to
reserve funds in a customer’s bank account.Possible values: True or False
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
Payments instructions related to the payment (MAX 255; MIN 3).Example: Go to your bank account and transfer the amount using the reference detailed
below
Decides whether to authorize the payment or capture it. Authorizing a card payment allows you
to
reserve funds in a customer’s bank account.Possible values: True or False
The issuer identification number (IIN) refers to the first few digits of the payment card
number issued by a financial institution (MAX 8; MIN 6).Example: 45079900
The unique identifier of the recipient in the Yuno system.You must provide the recipient_id (Yuno-generated) or the ‘provider_recipient_id’ (external provider’s ID) when creating a payment.
The recipient ID provided by the external payment provider, if applicable.You must provide the provider_recipient_id or the recipient_id (Yuno-generated) when creating a payment.
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.
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
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.
Specifies a metadata key and the respective value.Use to attach merchant-defined context (for example: order_id, customer_tier). Avoid sending sensitive or personal data.
Optional field to send in the payment indicating if the fraud screening is stand alone, meaning that a payment will not be excecuted after the fraud screening is made. You can use this field while creating your CARD route.Example: false