Create Payment Link

post

https://api-sandbox.y.uno/v1/payment-links

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account_id

string

required

The unique identifier of the account. You find this information on the Yuno Dashboard (MAX 64; MIN 36).

description

string

The description of the payment link (MAX 255; MIN 3).

country

string

enum

required

The customer's country code (MAX 2; MIN 2; ISO 3166-1) [Required].

merchant_order_id

string

Identification of the payment link transaction defined by the merchant (MAX 255; MIN 3).

amount

object

required

Specifies the payment amount object, with the value and currency.

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 not set, true by default.

type

string

The type of the payment link.

status

string

The status of the payment link.

payment_method

object

Payment method object (optional).

installments_plan

object

Installments plan configuration (optional).

timezone

string

Timezone for availability (e.g., UTC +03:00).

payments_number

integer

Number of payments associated with this link.

split_payment_methods

boolean

Allow split payment methods.

taxes

array of objects

Specifies the payment taxes list. Only available for COL.

taxes

customer_payer

object

Specifies customer object for payments.

additional_data

object

Specifies the additional_data object. This object is not mandatory. However, if you send this information, the payment experience will be enhanced for your user.

callback_url

string

URL to redirect the customer after the payment (MAX 256).

one_time_use

boolean

true allows only one use, false multiple payments

availability

object

The availability object. Refers to the Payment Link expiration date.

payment_method_types

array of strings

required

The list of types of payment methods that customers can use. Check the available payment methods on Payment type. If no value is passed, Yuno will display the payment methods defined in the dashboard.

payment_method_types*

metadata

array of objects

Specifies a list of metadata objects. You can add up to 50 metadata objects.

metadata

vault_on_success

boolean

Flag to enroll the card after a successful payment

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400