Skip to main content
POST
/
payment-links
Create Payment Link
curl --request POST \
  --url https://api-sandbox.y.uno/v1/payment-links \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "account_id": "493e9374-510a-4201-9e09-de669d75f256",
  "description": "Test",
  "country": "AR",
  "merchant_order_id": "AA01",
  "amount": {
    "value": 5000,
    "currency": "ARS"
  },
  "payment_method_types": [
    "CARD"
  ],
  "availability": {
    "start_at": "2023-01-15T14:00:12Z",
    "finish_at": "2023-12-29T14:00:12Z"
  }
}
'
{
  "code": "e1512b4d-9057-4c73-8e49-921c51eb5ba2",
  "country": "US",
  "availability": {
    "start_at": "2023-01-15T14:00:12Z",
    "finish_at": "2023-12-29T14:00:12Z"
  },
  "status": "CREATED",
  "merchant_order_id": "AA01",
  "description": "Test",
  "amount": {
    "currency": "USD",
    "value": 5000
  },
  "capture": true,
  "metadata": null,
  "split_payment_methods": false,
  "payment_method_types": [
    "CARD"
  ],
  "one_time_use": false,
  "payments": null,
  "callback_url": "https://checkout.sandbox.y.uno/payment/status",
  "installments_plan": null,
  "customer_payer": null,
  "taxes": null,
  "additional_data": {
    "airline": null,
    "order": null,
    "seller_details": null
  },
  "account_code": "493e9374-510a-4201-9e09-de669d75f256",
  "checkout_url": "https://checkout.sandbox.y.uno/payment?session=2f6d9754-43d0-4dca-b023-6aba4b107179",
  "payments_number": 0,
  "merchant_image": ""
}

Authorizations

​
public-api-key
string
header
default:<Your public-api-key>
required
​
private-secret-key
string
header
default:<Your private-secret-key>
required

Body

application/json
​
account_id
string
required

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

​
country
enum<string>
required

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

Available options:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
​
amount
object
required

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

​
payment_method_types
string[]
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.

​
description
string

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

​
merchant_order_id
string

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

​
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
object[]

Specifies the payment taxes list. Only available for COL.

​
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.

​
metadata
object[]

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

Response

200

​
code
string
Example:

"e1512b4d-9057-4c73-8e49-921c51eb5ba2"

​
country
string
Example:

"US"

​
availability
object
​
status
string
Example:

"CREATED"

​
merchant_order_id
string
Example:

"AA01"

​
description
string
Example:

"Test"

​
amount
object
​
capture
boolean
default:true
Example:

true

​
metadata
any
​
split_payment_methods
boolean
default:true
Example:

false

​
payment_method_types
string[]
​
one_time_use
boolean
default:true
Example:

false

​
payments
any
​
callback_url
string
Example:

"https://checkout.sandbox.y.uno/payment/status"

​
installments_plan
any
​
customer_payer
any
​
taxes
any
​
additional_data
object
​
account_code
string
Example:

"493e9374-510a-4201-9e09-de669d75f256"

​
checkout_url
string
Example:

"https://checkout.sandbox.y.uno/payment?session=2f6d9754-43d0-4dca-b023-6aba4b107179"

​
payments_number
integer
default:0
Example:

0

​
merchant_image
string
Example:

""