> ## 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 Link Object
## Attributes
This object represents a payment link that can be associated with a customer.
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 link (MAX 255; MIN 3).
Example: Marketplace payment
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 Payment link (MAX 255; MIN 3) (CREATED, USED, CANCELED, EXPIRED, ERROR).
Example: ACTIVE
Identification of the payment link (MAX 255; MIN 3).
Example: 432245
The date and time when the payment link was created.
Example: 2022-05-09T20:46:54.786342Z
The date and time of last update for the payment link.
Example: 2022-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. If the field is not sent, we will take it as true. You can later capture the
payment vía Yuno's dashboard or API method .
Example: true
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: 12100.00
Specifies customer object for payments links.
The unique identifier of the customer at
Yuno platform (MAX 255; MIN 3).
Example: faa89e18-5a11-11ed-9b6a-0242ac120002
The unique identifier of the customer in the external merchant (MAX 255; MIN 3).
Example: 23456
The customer's first name (MAX 255; MIN 3).
Example: John
The customer's last name (MAX 255; MIN 3).
Example: Doe
The customer's gender (MAX 2; 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.
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
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
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
Specifies the legs array of objects.
IATA airport code (MAX 3; MIN 3). See [http://www.iata.org](http://www.iata.org) .
Example: AMS
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
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.
Example: C
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.
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.
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
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 refunfable 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
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
Specifies the order object.
The fee amount of the order (multiple of 0.0001).
Example: 1
The shipping amount of the order (multiple of 0.0001).
Example: 1
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
The picture of the item (MAX 255; MIN 3).
Example: https\://www\.merchant\_url.com/items/:id
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.
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 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
Single Link: For a single collection with defined product, amount and customer information.
Multiple Link: To use and share as many times as necessary, with defined amount and product.
Options: false allows only one use, true multiple payments.
Specifies the availability object. Refers to the Payment Link expiration date.
Start of the validity period of the payment link.
Example: 2022-05-09T20:46:54.786342Z
End of the validity period of the payment link.
Example: 2022-05-09T20:46:54.786342Z
URL to redirect your customer after the payment (MAX 255; MIN 3).
Example: [https://www.your-site.com/](https://www.your-site.com/)
Payment Link URL (MAX 255; MIN 3).
Example: [https://checkout.y.uno/payment\_links/id](https://checkout.y.uno/payment_links/id)
The list of types of payment methods that customers can use. If no value is passed, Yuno will display the
payment methods defined in the dashboard.
Array of Payment objects
Specifies a list of metadata objects. You can add up to 50 metadata objects.
Specifies a metadata key and the respective value.
Specifies one metadata key.
Example: age
Specifies the value for the defined metadata key.
Example: 28
Flag to enroll the card after a successful payment. False by default.
Example: false