Skip to main content

Attributes

This object represents a payment link that can be associated with a customer.
id
string
The unique identifier of the customer (MAX 64 ; MIN 36).Example: 8546df3a-b83e-4bb5-a4b3-57aa6385924f
account_id
string
The unique identifier of the account (MAX 64; MIN 36).Example: 9104911d-5df9-429e-8488-ad41abea1a4b
description
string
The description of the payment link (MAX 255; MIN 3).Example: Marketplace payment
country
enum
Country where the transaction must be processed (MAX 2; MIN 2; ISO 3166-1 ).Possible enum values: Check the Country reference.
status
enum
The status of the Payment link (MAX 255; MIN 3) (CREATED, USED, CANCELED, EXPIRED, ERROR).Example: ACTIVE
merchant_order_id
string
Identification of the payment link (MAX 255; MIN 3).Example: 432245
created_at
timestamp
The date and time when the payment link was created.Example: 2022-05-09T20:46:54.786342Z
updated_at
timestamp
The date and time of last update for the payment link.Example: 2022-05-09T20:46:54.786342Z
capture
boolean
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
amount
object
Specifies the payment amount object, with the value and currency.
customer_payer
object
Specifies customer object for payments links.
additional_data
object
Specifies the additional_data object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.
taxes
array of objects
Specifies the order’s tax object.
one_time_use
boolean
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.
availability
object
Specifies the availability object. Refers to the Payment Link expiration date.
callback_url
string
URL to redirect your customer after the payment (MAX 255; MIN 3).Example: https://www.your-site.com/
redirect_url
string
Payment Link URL (MAX 255; MIN 3).Example: https://checkout.y.uno/payment_links/id
payment_method_types
array of enums
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.
payment
array of objects
metadata
array of objects
Specifies a list of metadata objects. You can add up to 50 metadata objects.
vault_on_success
boolean
Flag to enroll the card after a successful payment. False by default.Example: false