> ## Documentation Index
> Fetch the complete documentation index at: https://docs.y.uno/llms.txt
> Use this file to discover all available pages before exploring further.
# The Payment Object
This object represents the payment created after generating the checkout session for a customer. To refund a payment, see [Refund payments](/docs/refund-payments) and the [Refund payment](/reference/refund-payment) API.
**Metadata and routing logic**
For routing logic to work correctly, metadata must **also** be set at the [Checkout Session](/reference/the-checkout-session-object) level. Setting it only on the Payment object will not trigger route logic.
The unique identifier of the customer (MAX 64 ; MIN 36).
Example: 8546df3a-b83e-4bb5-a4b3-57aa6385924f
The unique identifier of the account (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
The description of the payment (MAX 255; MIN 3).
Example: Purchase on web
Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1 ).
Possible enum values: Check the Country reference.
The status of the transaction.
Example: SUCCEEDED
It is a complement to the status information.
Example: DECLINED
The unique identifier of the customer's order (MAX 255; MIN 3).
Example: 0000023
The date and time when the payment was created.
Example: 2022-05-09T20:46:54.786342Z
The date and time of last update for the payment.
Example: 2022-05-09T20:46:54.786342Z
optional
The idempotency key sent when creating the payment; present when the payment was created with an idempotency key.
Example: fc0d89a1-8d18-4759-8d0a-ee1c6d0386e2
optional
The account code associated with the payment (account identifier).
Example: 26a6626c-d3ec-4caa-bf7c-a994b145dc00
optional
Present when the payment was created via a payment link; identifies the payment link used.
Example: (empty string when not from a payment link)
optional
Present when the payment is associated with a subscription; the subscription identifier.
Example: null
optional
Indicates whether the payment was created in simplified mode (e.g. for certain flows such as subscription or retry).
Example: false
Specifies the payment amount object, with the value and currency.
The currency used to make the payment (MAX 3; MIN 3; ISO 4217 ).
Possible enum values: Check the Country reference.
The payment amount (multiple of 0.0001).
Example: 111111
Specifies the currency conversion object.
The unique identifier of the conversion rate query from the provider (MAX 526 ; MIN 3).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
The currency to make the conversion (ISO 4217 MAX 3; MIN 3).
Example: USD
Amount of the payment before conversion
Example: 100
The refund amount (multiple of 0.0001).
Example: 111111
The captured amount (multiple of 0.0001).
Example: 111111
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.
The checkout session has been created for the payment (MAX 64; MIN 36).
Example: 757eefc7-e28c-4333-9a07-3b16e610745d
Defines if the payment is asynchronous and requires additional steps based on a request to the SDK.
Example: false
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.
Specifies one metadata key (MAX 48).
Example: age
Specifies the value for the defined metadata key (MAX 512).
Example: 28
Specifies the payment\_method object.
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.
Specifies the details of the payment method when using a card.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
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 card installments (MAX 50; MIN 1).
Example: 3
Number of months to wait to debit the first installment.
Example: 1
Defines the type of installments.
Example: string
The installment amount includes interests associated with the installment and the information is
defined by the provider.
Example: 3
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 acquirer's response code.
Example: 742A64
The unique identifier assigned by an acquirer to an authorization. In case of Brazil, you'll receive the nsu.
Example: 200000000012
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
Specifies the details of the card.
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: Fannie Weissnat
User card country code (MAX 2; MIN 2).
Example: US
Card's expiration month (MM) (MAX 2; MIN 2).
Example: 03
Card's expiration year (YYYY) (MAX 4; MIN 2).
Example: 2030
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 19; MIN 8).
Example: 41961111
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: VISA
The card's issuer (MAX 255; MIN 3).
Example: Banco Galicia
The card's issuer identification code (MAX 255; MIN 3).
The category of the card's issuer (MAX 255; MIN 3).
Example: Gold
The type of the card's issuer (MAX 255; MIN 3).
Example: CREDIT, DEBIT, or CHARGE\_CARD
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
Specifies the details of the 3DS Transaction.
Setup ID obteined for the 3DS Direct flow.
Example: 24127d61-b852-42fb-acd4-1ee661645376
Refers to the protocol version of the EMV 3-D Secure specification used. 1.0, 2.0, 2.1.0,
2.2.0, 2.2.1.
Example: 2.2.1
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”
Transaction ID generated by the Mastercard directory server during authentication (MAX 255;
MIN 3).
Example: f38e6948-5388-41a6-bca4-b49723c19437
Information about the network token used for the transaction. If applicable.
The provider associated to the token provided. VISA, MASTERCARD, AMERICAN\_EXPRESS.
Example: MASTERCARD
Status of the token for the payment method. CREATED, ACTIVE, SUSPENDED, CANCELED.
Example: ACTIVE
Payment account reference.
Example: MCC123456789012
Token details.
\[Mandatory] - Token’s number without any separators (MAX 19; MIN 8) only available for PCI certified merchants.
Example: 450799000001234
Cardholder’s full name as it appears on the Token (MAX 26; MIN 3).
Example: John Doe
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
Last four digits of the network token (MAX 4; MIN 4).
Example: 1234
Network Token’s expiration month (MM) (MAX 2; MIN 2).
Example: 12
Network Token’s expiration year (YYYY) (MAX 4; MIN 2).
Example: 2027
\[Mandatory] - The unique cryptogram generated by the issuer for the network token in use in the transaction.
\[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.
\[Only required for certain providers] - Token requestor ID of the merchant
Network transaction details.
Response code from the service provider.
Example: succeeded
Response code from the service provider.
Example: Transaction Succeeded
Indicates the processing type of the transaction.
Indicates the processing type of the transaction.Enum:CARD\_ON\_FILE, SUBSCRIPTION, UNSCHEDULED\_CARD\_ON\_FILE
Example: SUBSCRIPTION
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, USED
Example: USED
This field lets you indicate the identification of the agreement with the customer for a subscription. Mainly for MX (MAX 255; MIN 3).
Example: AA0001
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
Specifies the details of the payment method when using Buy Now Pay Later (BNPL).
The loan installments (MAX 50; MIN 1).
Example: 10
The provider's URL (MAX 255; MIN 3).
Example: [https://www.company.com/](https://www.company.com/)
The URL with the full version of the ticket in case you want to redirect your customer (MAX 255;
MIN
3\).
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
Specifies the details of the customer.
The customer's legal name (MAX 32, MIN 8).
Example: Legal name
Customer's username in the provider platform (MAX 32, MIN 8).
Example: Legal\_name\_01
The customer's tax identifier (MAX 32, MIN 8).
Example: CUIT
The customer's tax identifier number (MAX 32, MIN 8).
Example: 20-34566123-7
The credit's type (MAX 255; MIN 3).
Example: PERSONAL/BUSINESS
The customer's industry (MAX 255; MIN 3).
Example: OTHERS
The customer's role in the company (MAX 255; MIN 3).
Example: OWNER
Specifies the details of the payment method when using bank transfer.
The provider's URL (MAX 255; MIN 3).
Example: [https://www.company.com/](https://www.company.com/)
Type of the bank account (MAX 255; MIN 3).
Example: CHECKINGS/SAVINGS
Name of the bank associated with the account (MAX 255; MIN 3).
Example: Banco Galicia
Identifier of the selected bank when the provider requires choosing one (MAX 255; MIN 1). Optional.
Example: galicia
The name of the account holder (MAX 255; MIN 3).
Example: John Doe
The number of the bank account (MAX 255; MIN 3).
Example: 54653211313333
The secondary number of the bank account (MAX 255; MIN 3).
Example: 78900000000123
Document type of the account holder (MAX 255; MIN 3).
Possible values: Check the
Country reference. Example: DNI
Document number of the account holder (MAX 255; MIN 3).
Example: 54666897
Reference code for the user (MAX 255; MIN 3).
Example: AA01234-BC
The unique identifier assigned by an acquirer to an authorization.In case of Brazil, you'll receive the nsu.
Example: 200000000012
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
The URL with the full version of the ticket in case you want to redirect your customer (MAX 255;
MIN
3\).
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
Specifies the details of the payment method when using a wallet.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
Cryptogram for direct integrations with card wallets (MAX 526; MIN 3).
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
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 card installments (MAX 50; MIN 1).
Example: 3
The user's payment method used in their wallet.
Example: credit\_card
The payment method's detail used in their wallet.
Example: visa
Date in which the money from the provider will be available to use.
Example: 2022-05-09T00:00:00.000000Z
Partner's provider account (MAX 255; MIN 3).
Example: 4562103
Acquire's response code.
Example: 742A64
Specifies the details of the customer.
The customer's email (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
The customer's first name (MAX 32, MIN 8).
Example: John
The customer's last name (MAX 32, MIN 8).
Example: Doe
The customer's username in the platform (MAX 32, MIN 8).
Example: John\_Doe\_01
The customer's document type (MAX 32, MIN 8).
Check the
Country reference. Example: DNI
The customer's identification number (MAX 32, MIN 8).
Example: 34566123
Specifies the details of the fees.
Amount of the transaction (multiple of 0.0001).
Example: 40.5
Specifies the details of the card.
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 2; MIN 1).
Example: 16
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: visa
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: JOHN DOE
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.
Indicates the reason for storing credentials for the transaction.Enum:CARD\_ON\_FILE, SUBSCRIPTION, UNSCHEDULED\_CARD\_ON\_FILE
Example: SUBSCRIPTION
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, USED
Example: USED
This field lets you indicate the identification of the agreement with the customer for a subscription. Mainly for MX (MAX 255; MIN 3).
Example: AA0001
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.
Example: 1
The total number of billing cycles for the subscription (MIN 1).
Specifies the frequency type (e.g., DAY, WEEK, MONTH, YEAR) and value. Enter data on all fields if using this object.
Specifies the frequency type (e.g., DAY, WEEK, MONTH, YEAR).
Example: MONTH
Specifies the frequency value.
Specifies the `availability` object. Defines a date interval based on starting and ending dates when the subscription is available to use.
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` .
Specifies the details of the payment method when using ticket.
The ticket's type.
Example: number, barcode, custom, reference\_code, qr
User´s benefit type for ticket payment method. JUNAEB, PRIVATE
Example: PRIVATE
The ticket's number.
Example: 13141
The ticket's barcode.
Example: 456789009878765u7654
The ticket's logo.
Example: [https://www.company.com/logo](https://www.company.com/logo)
The ticket's format.
Example: barcode, custom
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
The URL with the full version of the ticket.
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
Specifies the details of the payment method when using a payment link.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
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`
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
The card installments (MAX 50; MIN 1).
Example: 3
The user's payment method used in their wallet.
Example: credit\_card
The payment method's detail used in their wallet.
Example: visa
Date in which the money from the provider will be available to use.
Example: 2022-05-09T00:00:00.000000Z
Partner's provider account (MAX 255; MIN 3).
Example: 4562103
Acquire's response code.
Example: 742A64
Specifies the details of the customer.
The customer's email (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
The customer's first name (MAX 32, MIN 8).
Example: John
The customer's last name (MAX 32, MIN 8).
Example: Doe
The customer's username in the platform (MAX 32, MIN 8).
Example: John\_Doe\_01
The customer's document type (MAX 32, MIN 8).
Possible values: Check the
Country reference. Example: DNI
The customer's identification number (MAX 32, MIN 8).
Example: 34566123
Specifies the details of the fees.
Amount of the transaction (multiple of 0.0001).
Example: 40.5
Specifies the details of the card.
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 2; MIN 1).
Example: 16
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: visa
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: John Doe
Card's expiration month (MM) (MAX 2; MIN 2).
Example: 03
Card's expiration year (YYYY) (MAX 4; MIN 2).
Example: 30
Specifies customer object for payments.
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 unique identifier of the customer in the external merchant (MAX 255; MIN 3).
Example: 4ce6f7e1-bf2e-4e7f-bc1b-84b26082a1d3
Customer´s registration date on the merchants platform (ISO 8601 MAX 27; MIN 27).
Example: 2022-05-09T20:46:54.786342Z
Fraud validations for the customer payer.
If the customer's account has been validated before on the merchant's side. Defaults to true.
Possible values: `True` or `False`
If the customer's email has been validated before on the merchant's side. Defaults to true.
Possible values: `True` or `False`
If the customer's phone has been validated before on the merchant's side. Defaults to true.
Possible values: `True` or `False`
The customer's first name (MAX 255; MIN 1).
Example: John
The customer's last name (MAX 255; MIN 1).
Example: Doe
The customer's gender (MAX 1; MIN 1; (M=Male/F=Female/NA=Not applicable/NK=Not Known)).
Possible enum values: `M`, `F`, `NA`, or `NK`.
The customer's date of birth in the YYYY-MM-DD format (Length: 10).
Example: 1990-02-28
The customer's e-mail (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
The customer's nationality (MAX 2; MIN 2; ISO 3166-1 ).
Possible enum values: Check the Country reference.
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 fraud screening provider id
Example: RISKIFIED
The device fingerprint associated to the provider
Example: hi88287gbd8d7d782ge.....
The customer's IP address (MAX 45; MIN 7).
Example: 192.168.123.167
Specifies the browser\_info object.
The accept header value of the customer's browser.
Possible values: `True` or `False`
The accept browser value of the customer's browser
Possible values: `"True"` or `"False"`
The accept content value of the customer's browser
Possible values: `"True"` or `"False"`
The platform from which the customer is making the payment.
Possible enum values: `WEB`, `IOS`, `ANDROID`
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
Indicates if Javascript is enabled or not in the device.
Possible values: `True` or `False`
Indicates if Java is enabled or not in the device.
Possible values: `True` or `False`
Indicates the brosner time difference
Example: -3:00
The navigator.language value of the customer's browser (as defined in IETF BCP 47) (MAX 5; MIN 1).
Example: es-ES
The total height of the customer's device screen in pixels (MAX 255; MIN 3).
Example: 2048
The total width of the customer's device screen in pixels (MAX 255; MIN 3).
Example: 1152
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 customer's document object, including its number and type.
The customer's document number (MAX 40; MIN 3).
Example: 1093333333
The customer's document type (MAX 6, MIN 2).
Possible enum values: Check the
Country reference.
Specifies the customer's phone object, including number and code.
The customer's phone number (MAX 40; MIN 3).
Example: 11992149494
The country calling code of the customer's phone (MAX 3; MIN 1).
Possible values: Check the
Country reference.
Specifies the customer's billing address object.
The primary billing address line of the customer (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
The secondary billing address line of the customer (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
The city considered for the billing address (MAX 255; MIN 3).
Example: Bogotá
The country considered for the billing address (MAX 2; MIN 2; ISO
3166-1 ).
Possible enum values: Check the Country reference.
The state considered for the billing address (MAX 255; MIN 3).
Example: Cundinamarca
The zipcode considered for the billing address (MAX 11; MIN 4).
Example: 111111
The neighborhood of the address line of the customer(MAX 255; MIN 2).
Example: Barrio 11
Specifies the customer's shipping address object.
The primary shipping address line of the customer (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
The secondary shipping address line of the customer (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
The city considered for the shipping address (MAX 255; MIN 3).
Example: Bogotá
The country considered for the shipping address (MAX 2; MIN 2; ISO
3166-1 ).
Possible enum values: Check the Country reference.
The state considered for the shipping address (MAX 255; MIN 3).
Example: Cundinamarca
The zipcode considered for the shipping address (MAX 11; MIN 4).
Example: 111111
The neighborhood of the address line of the customer (MAX 255; MIN 2).
Example: Barrio 11
Customer's geolocation.
Angular distance of a location on the earth south or north of the equator (MIN: 1, MAX:11)
Example: −34.4905
Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory. (MIN: 1, MAX:11)
Example: −58.5555
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.
Specifies the airline object. Passengers and tickets should have the same order information.
Passenger name record (MAX 10; MIN 1).
Example: 1P-2UUGJW
Type of trip.
Possible values: `ONE_WAY`, `ROUNDTRIP`, `MULTIPLE_DESTINATIONS`
Specifies the legs array of objects.
A running index (starts with 1), describing the order of legs in the same route.
Example: 2
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
IATA airport code (MAX 3; MIN 3). See [http://www.iata.org](http://www.iata.org) .
Example: AMS
Country of the arrival airport (MAX 2; MIN 2; ISO 3166-1).
Example: AR
The city considered for the arrival airport (MAX 255; MIN 3).
Example: BUE
Airport timezone (MAX 6; MIN 6).
Example: -03:00
The arrival date and time in local time at the arrival airport.
Example: 2022-05-09T24:46:54.786342Z
The transaction amount, excluding taxes and fees, the smallest unit of currency (multiple of
0.0001).
Example: 23.5676
The currency used to transaction amount (MAX 3; MIN 3; ISO 4217 ).
Example: Check the Country reference.
IATA carrier code (MAX 2; MIN 2). See [http://www.iata.org](http://www.iata.org) .
Example: KL
IATA code (MAX 3; MIN 3). See [http://www.iata.org](http://www.iata.org) .
Example: EZE
Country of the departure airport (MAX 2; MIN 2; ISO 3166-1).
Example: AR
The city of the departure airport (MAX 2; MIN 2; ISO 3166-1).
Example: AR
Airport timezone (MAX 6; MIN 6).
Example: -03:00
The departure date and time in local time at the departure airport.
Example: 2022-05-09T20:46:54.786342Z
Code base rate provides specific information on the fare in addition to the class service, both
required for booking (MAX 15; MIN 1).
Example: HL7LNR
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 flight number assigned by the airline carrier (MAX 5; MIN 1).
Example: 842
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
Specifies the array of objects that represents the passengers associated to the tickets.
Country where the document was issued (MAX 2; MIN 2; ISO 3166-1 ).
Possible enum values: Check the Country reference.
The passenger's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).
Example: 1990-02-28
Specifies the document object for the passenger.
The passenger's document number (MAX 40; MIN 3).
Example: 1093333333
The passenger's document type (MAX 6, MIN 2).
Possible enum values: Check the
Country reference.
Specifies the phone object for the passenger.
The country calling code of the passenger's phone (MAX 3; MIN 1).
Possible values: Check the
Country reference
The passenger's phone number, without the country code (MAX 32; MIN 1).
Example: 1130292837
The passenger's email (MAX 255; MIN 3).
Example: [John.Doe@gmail.com](mailto:John.Doe@gmail.com)
The passenger's first name (MAX 255; MIN 3).
Example: John
The passenger's last name (MAX 255; MIN 3).
Example: Doe
Number of passenger loyalty program (MAX 20, MIN 1).
Example: 254587547
Tier of passenger loyalty program (MAX 255; MIN 3).
Possible enum values: Check the
Loyalty tier.
The passenger's middle name (MAX 255; MIN 3).
Example: Charles
The passenger's nationality (MAX 2; MIN 2; ISO 3166-1 ).
Possible enum values: Check the Country reference.
The type of passenger (MAX 1; MIN 1).
Possible enum values: Check the Passenger type list.
Specifies the array of tickets associated with the passengers.
Ticket number (MAX 14; MIN 1).
Example: 7411823255523
Is this an e-ticket?
Possible values: `True` or `False`
Indicates if the ticket is refundable or not.
Possible values: `True` or `False`
Total fare amount in the smallest unit of currency (multiple of 0.0001).
Example: 80000
Total taxes amount in the smallest unit of currency (multiple of 0.0001).
Example: 14800
Total fee amount in the smallest unit of currency (multiple of 0.0001).
Example: 25200
Specifies the issue object.
Address of the agent who sold the ticket (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
Zip code of the agent who sold the ticket.
Example: 1636
Issuing or Validating carrier. This is the AWB Prefix (Air waybill) IATA 3-numeric code (MAX
3; MIN
3\).
Example: 044
City name of the agent who sold the ticket (MAX 255; MIN 3).
Example: Bogotá
Country code where the ticket was issued (MAX 2; MIN 2; ISO
3166-1 ).
Possible enum values: Check the Country code
list.
Ticket issuing date.
Example: 1979-01-12
Code of the travel agent issuing the ticket.
Example: 10655823
The name under which the point of sale appears on the agency list or franchise name (MAX 32;
MIN
1\).
Example: ACME Agency Inc
Code of the booking system issuing the ticket. (MAX 255; MIN 1).
Example: TEST001
Name of the booking system issuing the ticket. (MAX 255; MIN 1).
Example: Booking system
Specifies the transport object.
The id of the transportation vehicle (MAX 255; MIN 1).
Example: ASONDAKS-1234
Specifies the order object.
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
Sales channel id of the payment. (MIN:3 y MAX:255)
Example: AA01
Specifies the order's tax object.
Type of the tax.
Example: VAT
The amount base to apply the tax defined.
Example: 10000
The amount of the tax.
Example: 2100
The percentage of the tax.
Example: 21
Specifies the item's object.
The unique identifier of the item (MAX 255; MIN 3).
Example: 3214
The name of the item (MAX 255; MIN 3).
Example: iPhone 12 Pro Max
The quantity of the item (MAX 999; MIN 1).
Example: 1
The unit amount of the item (multiple of 0.0001).
Example: 550
The category of the item (MAX 255; MIN 3).
Possible values: Check the Item category list.
The brand of the item (MAX 255; MIN 3).
Example: Apple
The stock keeping unit (SKU) of the item (MAX 255; MIN 3).
Example: A2342
The manufacture part number of the item (MAX 255; MIN 3).
Example: 345621234
Specifies the order's discounts array of objects.
ID of the discount (MAX 255; MIN 3).
Example: 10OFF
The name of the discount (MAX 255; MIN 3).
Example: Offer
The amount of the discount (multiple of 0.0001).
Example: 100
Specifies the tickets object.
Id of the ticket (Min: 1, max:255)
Example: 3214
Name of the ticket (Min: 1, max:255)
Example: Concert
Description of the ticket (Min: 1, max:255)
Example: Concert
Type of ticket
VIRTUAL / PHYSICAL
Specifies the payment amount object, with the value and currency.
The currency used to make the payment (MAX 3; MIN 3; ISO 4217 ).
Possible enum values: Check the Country reference.
The payment amount (multiple of 0.0001).
Example: 111111
Specifies the event details object.
Id of the event related to the ticket
Example: AA01
Name of the event (Min: 1, max:255)
Example: Music
Description of the event (Min: 1, max:255)
Example: festival
Type of event
PARTY, UNIVERCITY, FESTIVAL, CIRCUS, SPORTS, CINEMA, THEATER, CONCERT, OTHERS.
Date of the event
Example: 2025-10-25
Specifies the event's address object.
The primary address line of the event (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
The secondary billing address line of the event (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
The city considered for the event's address (MAX 255; MIN 3).
Example: Bogotá
The country considered for the event's address (MAX 2; MIN 2, ISO
3166-1 ).
Possible enum values: Check the Country code
list.
The state considered for the event's address (MAX 255; MIN 3).
Example: Cundinamarca
The zipcode considered for the event's address (MAX 11; MIN 4).
Example: 111111
Specifies the shipping details object.
Type of shippment.
Example: STANDARD
Possible enum values: Check the Shipping reference.
The description of the shipping (MAX 255; MIN 1).
Example: Shipping of sample shirt
The carrier used for the delivery.
Example: UPS
Possible enum values: Check the Shipping reference.
Estimated date of delivery (ISO 8601 MAX 27; MIN 27).
Example: 2025-09-17T20:43:54.786342Z
Specifies the account funding structure for transfers and payments.
Specifies the sender's information.
Sender's national entity type. Possible values:
* `INDIVIDUAL`
* `ENTITY`
Sender's first name (MAX 80).
Example: John
Sender's last name (MAX 80).
Example: Doe
Recipient's legal name. Required if `national_entity` is `ENTITY` (MAX 80).
Example: Arcos dorados S.A.
Sender's email (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
Sender's country (MAX 2; MIN 2; ISO 3166-1 ).
Possible enum values: Check the Country reference.
Sender's date of birth in the `YYYY-MM-DD` format (MAX 10; MIN 10).
Example: 1990-02-28
Specifies the phone object.
Sender's phone country code (MAX 3; MIN 2).
Example: 57
Sender's phone number (MAX 32; MIN 1).
Example: 3132450765
Specifies the document object.
Sender's national document ID (MAX 40; MIN 3).
Example: 1093333333
Sender's document type (MAX 6; MIN 2).
Example: CC
Specifies the address object.
Primary billing address (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
Secondary billing address (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
City for the billing address (MAX 255; MIN 3).
Example: Bogota
Country for the billing address (ISO 3166-1; MAX 2; MIN 2).
Example: CO
State or province for the billing address (MAX 255; MIN 3).
Example: Cundinamarca
ZIP code for the billing address (MAX 11; MIN 4).
Example: 111111
Specifies the recipient's information.
Recipient's national entity type. Possible values:
* `INDIVIDUAL`
* `ENTITY`
Sender's first name (MAX 80).
Example: John
Sender's last name (MAX 80).
Example: Doe
Recipient's legal name. Required if `national_entity` is `ENTITY` (MAX 80).
Example: Arcos dorados S.A.
Recipient's email (MAX 255; MIN 3).
Example: [recipient@example.com](mailto:recipient@example.com)
Recipient's country (MAX 2; MIN 2; ISO 3166-1 ).
Possible enum values: Check the Country reference.
Recipient's date of birth in the `YYYY-MM-DD` format (MAX 10; MIN 10).
Example: 1985-07-15
Specifies the phone object.
Recipient's phone country code (MAX 3; MIN 2).
Example: 57
Recipient's phone number (MAX 32; MIN 1).
Example: 3132450765
Specifies the document object.
Recipient's national document ID (MAX 40; MIN 3).
Example: 1093333333
Recipient's document type (MAX 6; MIN 2).
Example: CC
Specifies the address object.
Primary billing address (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
Secondary billing address (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
City for the billing address (MAX 255; MIN 3).
Example: Bogota
Country for the billing address (ISO 3166-1; MAX 2; MIN 2).
Example: CO
State or province for the billing address (MAX 255; MIN 3).
Example: Cundinamarca
ZIP code for the billing address (MAX 11; MIN 4).
Example: 111111
Specifies the seller's details object.
The seller's legal name (MAX 255; MIN 3).
Example: Jhon Doe
The seller's e-mail (MAX 255; MIN 3).
Example: [jhondoe@business.com](mailto:jhondoe@business.com)
The seller's identification code (MAX 255; MIN 3).
Example: Seller
The seller's website URL (MAX 255; MIN 3).
Example: [https://www.test.com/1231324](https://www.test.com/1231324)
The seller's industry (MAX 255; MIN 3).
Possible enum values: Check the Industry category.
MCC - The merchant category code (MAX 235; MIN 1).
Example: 6199
The seller's country (MAX 255; MIN 3).
Possible enum values: Check the Country code list.
Specifies the document object of the seller.
The seller's document number (MAX 40; MIN 3).
Example: 1093333333
The seller's document type (MAX 6, MIN 2).
Possible enum values: Check the
Country reference.
Specifies the seller's phone number object.
The country calling code of the seller's phone (MAX 3; MIN 1). Possible values: Check the
Country reference .
Example: 57
The seller's phone number, without the country code (MAX 32; MIN 1).
Example: 3132450765
Specifies the seller's address object.
The primary address line of the seller (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78
The secondary billing address line of the seller (MAX 255; MIN 3).
Example: Apartamento 502, Torre I
The city considered for the seller's address (MAX 255; MIN 3).
Example: Bogotá
The country considered for the seller's address (MAX 2; MIN 2, ISO
3166-1 ).
Possible enum values: Check the Country code
list.
The state considered for the seller's address (MAX 255; MIN 3).
Example: Cundinamarca
The zipcode considered for the seller's address (MAX 11; MIN 4).
Example: 111111
Specifies the transportations array of objects.
The id of the transportation booking (MAX 255; MIN 1).
The description of the transportation booking (MAX 255; MIN 1).
The type of transportation booking.
Specifies the legs array of objects.
A running index (starts with 1), describing the order of legs in the same route.
A running index (starts with 1), describing the order of routes by time.
Country of the departure (MAX 2; MIN 2; ISO 3166-1).
The city of the departure (MAX 255; MIN 1).
Departure timezone (MAX 6; MIN 6).
The departure date and time in local time at the departure.
The reference of the departure (MAX 255; MIN 1).
Country of the arrival (MAX 2; MIN 2; ISO 3166-1).
The city of the arrival (MAX 255; MIN 1).
Arrival timezone (MAX 6; MIN 6).
The arrival date and time in local time at the arrival.
The reference of the arrival (MAX 255; MIN 1).
Specifies the transport object.
The id of the transportation vehicle (MAX 255; MIN 1).
The type of transportation vehicle.
The description of the transportation vehicle (MAX 255; MIN 1).
Specifies the transaction details associated with a payment.
The unique identifier of the transaction (MAX 64; MIN 36).
Example: 7bf8f1f6-4081-41ec-a024-a927056e00ab
The transaction type.
Example: PURCHASE
The status of the transaction.
Example: SUCCEEDED
The category of the payment method used in the transaction.
Example: CARD
The amount of the transaction.
Example: 100
The id of the provider that processed the transaction.
Example: DLOCAL
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
Language code for the generated receipt (e.g. `EN` , `ES` , `PT` ). `null` if no receipt has been generated or no language was specified.
Example: EN
Specifies the payment method details used in the transaction.
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.
Flag to enroll the card after a successful payment.
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
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.
Specifies the details of the payment method when using a card.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
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 card installments (MAX 50; MIN 1).
Example: 3
Number of months to wait to debit the first installment.
Example: 1
Type of installments used in the card payment.
Example: string
The installment amount includes interests associated with the installment and the information
is
defined by the provider.
Example: 3
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 acquirer's response code.
Example: 742A64
The unique identifier assigned by an acquirer to an authorization. In case of Brazil, you'll receive the nsu.
Example: 200000000012
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
Specifies the details of the card.
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: Fannie Weissnat
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 2; MIN 1).
Example: 16
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: VISA
The card's issuer (MAX 255; MIN 3).
Example: Banco Galicia
The category of the card's issuer (MAX 255; MIN 3).
Example: Gold
The type of the card's issuer (MAX 255; MIN 3).
Example: CREDIT, DEBIT, or CHARGE\_CARD
`fingerprint` 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
Specifies the details of the 3DS Transaction.
Setup ID obteined for the 3DS Direct flow.
Example: 24127d61-b852-42fb-acd4-1ee661645376
Refers to the protocol version of the EMV 3-D Secure specification used. 1.0, 2.0, 2.1.0,
2.2.0, 2.2.1.
Example: 2.2.1
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”
Transaction ID generated by the Mastercard directory server during authentication (MAX
255; MIN 3).
Example: f38e6948-5388-41a6-bca4-b49723c19437
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
Unique identifier provided by the Access Control Server (ACS) during the 3-D Secure authentication process.
Example: ACS-1234567890
Information about the network token used for the transaction. If applicable.
The provider associated to the token provided. VISA, MASTERCARD, AMERICAN\_EXPRESS.
Example: MASTERCARD
Status of the token for the payment method. CREATED, ACTIVE, SUSPENDED, CANCELED.
Example: ACTIVE
Payment account reference.
Example: MCC123456789012
Token details.
\[Mandatory] Token’s number without any separators (MAX 19; MIN 8) only available for PCI certified merchants.
Example: 450799000001234
Cardholder’s full name as it appears on the Token (MAX 26; MIN 3).
Example: John Doe
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
Last four digits of the network token (MAX 4; MIN 4).
Example: 1234
Network Token’s expiration month (MM) (MAX 2; MIN 2).
Example: 12
Network Token’s expiration year (YYYY) (MAX 4; MIN 2).
Example: 2027
\[Mandatory] - The unique cryptogram generated by the issuer for the network token in use in the transaction.
\[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.
\[Only required for certain providers] - Token requestor ID of the merchant
Network transaction details.
Response code from the service provider.
Example: succeeded
Response code from the service provider.
Example: Transaction Succeeded
Indicates the processing type of the transaction.
Indicates the processing type of the transaction.Enum:CARD\_ON\_FILE, SUBSCRIPTION, UNSCHEDULED\_CARD\_ON\_FILE
Example: SUBSCRIPTION
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, USED
Example: USED
This field lets you indicate the identification of the agreement with the customer for a subscription. Mainly for MX (MAX 255; MIN 3).
Example: AA0001
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
Specifies the details of the payment method when using a wallet.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
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 card installments (MAX 50; MIN 1).
Example: 3
The user's payment method used in their wallet.
Example: credit\_card
The payment method's detail used in their wallet.
Example: visa
Date in which the money from the provider will be available to use.
Example: 2022-05-09T00:00:00.000000Z
Partner's provider account (MAX 255; MIN 3).
Example: 4562103
Acquire's response code.
Example: 742A64
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
Specifies the details of the customer.
The customer's email (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
The customer's first name (MAX 32, MIN 8).
Example: John
The customer's last name (MAX 32, MIN 8).
Example: Doe
The customer's username in the platform (MAX 32, MIN 8).
Example: John\_Doe\_01
The customer's document type (MAX 32, MIN 8).
Check the
Country reference. Example: DNI
The customer's identification number (MAX 32, MIN 8).
Example: 34566123
Specifies the details of the fees.
Amount of the transaction (multiple of 0.0001).
Example: 40.5
Specifies the details of the card.
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 19; MIN 8).
Example: 19
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: visa
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: JOHN DOE
Specifies the details of the payment method when using BNPL.
The loan installments (MAX 50; MIN 1).
Example: 10
The provider's URL (MAX 255; MIN 3).
Example: [https://www.company.com/](https://www.company.com/)
The URL with the full version of the ticket in case you want to redirect your customer (MAX
255;
MIN
3\).
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
Specifies the details of the customer.
The customer's legal name (MAX 32, MIN 8).
Example: Legal name
Customer's username in the provider platform (MAX 32, MIN 8).
Example: Legal\_name\_01
The customer's tax identifier (MAX 32, MIN 8).
Example: CUIT
The customer's tax identifier number (MAX 32, MIN 8).
Example: 20-34566123-7
The credit's type (MAX 255; MIN 3).
Example: PERSONAL/BUSINESS
The customer's industry (MAX 255; MIN 3).
Example: OTHERS
The customer's role in the company (MAX 255; MIN 3).
Example: OWNER
Specifies the details of the payment method when using bank transfer.
The provider's URL (MAX 255; MIN 3).
Example: [https://www.company.com/logo](https://www.company.com/logo)
Type of the bank account (MAX 255; MIN 3).
Example: CHECKINGS/SAVINGS
Name of the bank associated with the account (MAX 255; MIN 3).
Example: Banco Galicia
Identifier of the selected bank when the provider requires choosing one. Returned only if the merchant sent a value.
Example: galicia
The name of the account holder (MAX 255; MIN 3).
Example: John Doe
The number of the bank account (MAX 255; MIN 3).
Example: 54653211313333
The secondary number of the bank account (MAX 255; MIN 3).
Example: 78900000000123
Document type of the account holder (MAX 255; MIN 3).
Possible values: Check the
Country reference. Example: DNI
Document number of the account holder (MAX 255; MIN 3).
Example: 54666897
Reference code for the user (MAX 255; MIN 3).
Example: AA01234-BC
The unique identifier assigned by an acquirer to an authorization.In case of Brazil, you'll receive the nsu.
Example: 200000000012
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
The URL with the full version of the ticket in case you want to redirect your customer (MAX
255;
MIN
3\).
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
Specifies the details of the payment method when using ticket.
The ticket's type.
Example: number, barcode, custom, reference\_code, qr
User´s benefit type for ticket payment method. JUNAEB, PRIVATE
Example: PRIVATE
The ticket's number.
Example: 13141
The ticket's barcode.
Example: 456789009878765u7654
The ticket's logo.
Example: [https://www.company.com/logo](https://www.company.com/logo)
The ticket's format.
Example: barcode, custom
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
The URL with the full version of the ticket.
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
Specifies the details of the payment method when using a payment link.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
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`
Payment methods expiration date. "yyyy-MM-dd HH:mm:ss.SSSz"
Example: 2026-05-09T20:46:54.786342Z
The card installments (MAX 50; MIN 1).
Example: 3
The user's payment method used in their wallet.
Example: credit\_card
The payment method's detail used in their wallet.
Example: visa
Date in which the money from the provider will be available to use.
Example: 2022-05-09T00:00:00.000000Z
Partner's provider account (MAX 255; MIN 3).
Example: 4562103
Acquire's response code.
Example: 742A64
Specifies the details of the customer.
The customer's email (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
The customer's first name (MAX 32, MIN 8).
Example: John
The customer's last name (MAX 32, MIN 8).
Example: Doe
The customer's username in the platform (MAX 32, MIN 8).
Example: John\_Doe\_01
The customer's document type (MAX 32, MIN 8).
Possible values: Check the
Country Reference. Example: DNI
The customer's identification number (MAX 32, MIN 8).
Example: 34566123
Specifies the details of the fees.
Amount of the transaction (multiple of 0.0001).
Example: 40.5
Specifies the details of the card.
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 19; MIN 8).
Example: 19
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: visa
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: John Doe
The code that represents the response of the te outcome of the transaction.
Example: SUCCEEDED
The description of the response\_code.
Example: Transaction successful
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 description of the payment (MAX 255; MIN 3).
Example: Purchase on web
The reference generated by the merchant to identify the payment/transaction.
Example: AA01
Normalized Merchant Advice Code for declined transactions; use it to guide retry behavior and routing.
Example: TRY\_AGAIN\_LATER
Human‑readable message that explains the advice returned in `merchant_advice_code` .
Example: Retry within 24 hours
Specifies the provider data that processed the payment.
The provider id that processed the payment.
Example: DLOCAL
The id of the transaction from the provider.
Example: 5a1fa541-5fa2-496e-9fdc-29b34e09a107
The id of the account from the processor of the provider. If applies.
Example: AA001298
The id of the transaction from the processor of the provider. If applies.
Example: 1309982
The unique identifier of the account (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
The status of the transaction.
Example: SUCCEEDED
The status\_detail of the transaction.
Example: APPROVED
Raw Merchant Advice Code returned by the provider for declined transactions.
Example: 25
Provider message that explains the meaning of the raw Merchant Advice Code.
Example: Retry after 24 hours
The code that represents the response of the te outcome of the transaction from the provider.
Example: SUCCEEDED
Message to provide additional information regarding the operation status.
Example: Successful transaction
The code of the international standard for financial transaction card originated interchange messaging ( ISO 8583 ).
Example: 00
The message of the international standard for financial transaction card originated interchange messaging ( ISO 8583 ).
Example: Approved or completed successfully
The direct notification from the provider for the transaction. The format of the object depends on the
provider's response.
Example: JSON, XML, string
Specifies the payment method detail object returned by the provider, which specifies the details of the
different transaction
category types.
Specifies the details of the payment method when using a card.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
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 card installments (MAX 50; MIN 1).
Example: 3
Number of months to wait to debit the first installment.
Example: 1
Type of installments used in the card payment.
Example: string
The installment amount includes interests associated with the installment and the information
is
defined by the provider.
Example: 3
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 acquirer's response code.
Example: 742A64
The unique identifier assigned by an acquirer to an authorization. In case of Brazil, you'll receive the nsu.
Example: 200000000012
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
Specifies the details of the card.
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: Fannie Weissnat
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 2; MIN 1).
Example: 16
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: VISA
The card's issuer (MAX 255; MIN 3).
Example: Banco Galicia
The category of the card's issuer (MAX 255; MIN 3).
Example: Gold
The type of the card's issuer (MAX 255; MIN 3).
Example: CREDIT, DEBIT, or CHARGE\_CARD
Specifies the details of the payment method when using a wallet.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
`cryptogram` 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 card installments (MAX 50; MIN 1).
Example: 3
The user's payment method used in their wallet.
Example: credit\_card
The payment method's detail used in their wallet.
Example: visa
Date in which the money from the provider will be available to use.
Example: 2022-05-09T00:00:00.000000Z
Partner's provider account (MAX 255; MIN 3).
Example: 4562103
Acquire's response code.
Example: 742A64
Specifies the details of the customer.
The customer's email (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
The customer's first name (MAX 32, MIN 8).
Example: John
The customer's last name (MAX 32, MIN 8).
Example: Doe
The customer's username in the platform (MAX 32, MIN 8).
Example: John\_Doe\_01
The customer's document type (MAX 32, MIN 8).
Check the
Country reference. Example: DNI
The customer's identification number (MAX 32, MIN 8).
Example: 34566123
Specifies the details of the fees.
Amount of the transaction (multiple of 0.0001).
Example: 40.5
Specifies the details of the card.
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 19; MIN 8).
Example: 19
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: visa
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: JOHN DOE
Specifies the details of the payment method when using BNPL.
The loan installments (MAX 50; MIN 1).
Example: 10
The provider's URL (MAX 255; MIN 3).
Example: [https://www.company.com/logo](https://www.company.com/logo)
The URL with the full version of the ticket in case you want to redirect your customer (MAX
255;
MIN
3\).
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Specifies the details of the customer.
The customer's legal name (MAX 32, MIN 8).
Example: Legal name
Customer's username in the provider platform (MAX 32, MIN 8).
Example: Legal\_name\_01
The customer's tax identifier (MAX 32, MIN 8).
Example: CUIT
The customer's tax identifier number (MAX 32, MIN 8).
Example: 20-34566123-7
The credit's type (MAX 255; MIN 3).
Example: PERSONAL/BUSINESS
The customer's industry (MAX 255; MIN 3).
Example: OTHERS
The customer's role in the company (MAX 255; MIN 3).
Example: OWNER
Specifies the details of the payment method when using bank transfer.
The provider's URL (MAX 255; MIN 3).
Example: [https://www.company.com/](https://www.company.com/)
Type of the bank account (MAX 255; MIN 3).
Example: CHECKINGS/SAVINGS
Name of the bank associated with the account (MAX 255; MIN 3).
Example: Banco Galicia
Identifier of the bank selected by the payer when provided in the original payment request.
Example: galicia
The name of the account holder (MAX 255; MIN 3).
Example: John Doe
The number of the bank account (MAX 255; MIN 3).
Example: 54653211313333
The secondary number of the bank account (MAX 255; MIN 3).
Example: 78900000000123
Document type of the account holder (MAX 255; MIN 3).
Possible values: Check the
Country reference. Example: DNI
Document number of the account holder (MAX 255; MIN 3).
Example: 54666897
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
The URL with the full version of the ticket in case you want to redirect your customer (MAX
255;
MIN
3\).
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Specifies the details of the payment method when using ticket.
The ticket's type.
Example: number, barcode, custom, reference\_code, qr
The ticket's number.
Example: 13141
The ticket's barcode.
Example: 456789009878765u7654
The ticket's logo.
Example: [https://www.company.com/logo](https://www.company.com/logo)
The ticket's format.
Example: barcode, custom
The url with the full version of the ticket.
Example: [https://www.company.com/ticket\_1231324](https://www.company.com/ticket_1231324)
Specifies the details of the payment method when using a payment link.
Using amount = 0 and verify = true, you can verify the user's card without authorizing a real
amount.
Possible values: `True` or `False`
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 card installments (MAX 50; MIN 1).
Example: 3
The user's payment method used in their wallet.
Example: credit\_card
The payment method's detail used in their wallet.
Example: visa
Date in which the money from the provider will be available to use.
Example: 2022-05-09T00:00:00.000000Z
Partner's provider account (MAX 255; MIN 3).
Example: 4562103
Acquire's response code.
Example: 742A64
Specifies the details of the customer.
The customer's email (MAX 255; MIN 3).
Example: [john.doe@email.com](mailto:john.doe@email.com)
The customer's first name (MAX 32, MIN 8).
Example: John
The customer's last name (MAX 32, MIN 8).
Example: Doe
The customer's username in the platform (MAX 32, MIN 8).
Example: John\_Doe\_01
The customer's document type (MAX 32, MIN 8).
Possible values: Check the
Country reference. Example: DNI
The customer's identification number (MAX 32, MIN 8).
Example: 34566123
Specifies the details of the fees.
Amount of the transaction (multiple of 0.0001).
Example: 40.5
Specifies the details of the card.
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 last four digits of the card (MAX 4; MIN 4).
Example: 0010
The length of the card's number (MAX 19; MIN 8).
Example: 19
The length of the card's security code (MAX 1; MIN 1).
Example: 3
The card's brand information (MAX 255; MIN 3).
Example: visa
Card holder's full name as it appears on the card (MAX 26; MIN 3) only available for PCI
certified merchants.
Example: John Doe
Specifies the connection data object, which represents the connection used to process the transaction.
The unique identifier of the payment connection in Yuno (MAX 64 ; MIN 36).
Example: 88292fd3-bf5b-4b23-bb95-7186ba4e7f88
The date and time when the transaction was created.
Example: 2022-05-09T20:46:54.786342Z
The date and time from the last time the transaction was updated.
Example: 2022-05-09T20:46:54.786342Z
Split marketplace array of objects
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 type of split.
Example: PURCHASE
Optional unique identifier for the split transaction.
Defines the amount of the split.
The split amount (multiple of 0.0001).
The currency used to make the payment (MAX 3; MIN 3; ISO 4217).
Optional information regarding the recipient's liability for fees and chargebacks.
Indicates who will be charged the transaction fee.
The recipient is responsible in case of a chargeback.
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.
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](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.
Specifies one metadata key (MAX 48).
Example: age
Specifies the value for the defined metadata key (MAX 512).
Example: 28
Returns the routing rules information during the payment creation.
Specifies if a transaction went through the smart routing feature or not.
Example: false
Specifies if a transaction went through the monitors feature or not.
Example: false
Object with the corresponding information for the routing condition that applies to the payment
ID of the condition corresponding to the payment.
Example: 2404911d-5df9-429e-8488-ad41abea1a4b
The unique identifier of the subscription associated to the payment (MAX 64 ; MIN 36).
Example: 7304911d-5df9-429e-8488-ad41abea1a4c
Returns the subscription details associated to the payment.
Specifies the billing cycle of the subscription associated to the payment.
Example: 1
Specifies the retry attempt associated to the billing cycle of the subscription.
Example: 2
Provides information about the fraud scans used for the payment.
The final status of the screening process of the payment.
Example: SUCCEEDED
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
Specifies the transaction details associated with a screening process of the payment.
The id of the fraud transaction (MAX 64; MIN 36).
Example: ft12
Type of the fraud transaction.
Possible enum values: `PRE_AUTH`, `POS_AUTH`
The status of the transaction (MAX 255; MIN 3).
Example: SUCCEEDED
The response code of the transaction.
Example: FRAUD\_VERIFIED
The response message of the transaction.
Example: Fraud approved
Specifies the provider data that processed the payment.
The id of the fraud prevention provider.
Example: CLEARSALE
The id of the fraud transaction from the provider.
Example: AA001234567
The provider fraud transaction status.
Example: APM
The provider score for the transaction.
Example: 0.7
The raw\_response of the provider.
Example: JSON
The date and time when the fraud screening was created.
Example: 2022-05-09T20:46:54.786342Z
The date and time from the last time the fraud screening was updated.
Example: 2022-05-09T20:46:54.786342Z