Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Create Payment Link

post/payment-links

Request body

account_idstring required

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

descriptionstring

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

country'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'CR' | 'EC' | 'SV' | 'GT' | 'HN' | 'MX' | 'NI' | 'PA' | 'PY' | 'PE' | 'US' | 'UY' required

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

merchant_order_idstring

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

captureboolean

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.

typestring

The type of the payment link.

statusstring

The status of the payment link.

payment_methodobject

Payment method object (optional).

installments_planobject

Installments plan configuration (optional).

timezonestring

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

payments_numberinteger

Number of payments associated with this link.

split_payment_methodsboolean

Allow split payment methods.

callback_urlstring

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

one_time_useboolean

true allows only one use, false multiple payments

payment_method_typesstring[] 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.

vault_on_successboolean

Flag to enroll the card after a successful payment

Response

200

idstring
countrystring
statusstring
merchant_order_idstring
descriptionstring
captureboolean
{"stackTrail":"paths:/payment-links:post:responses:200:content:application/json:schema:properties:metadata","oasType":"schema","type":"unknown"}
split_payment_methodsboolean
payment_method_typesstring[]
one_time_useboolean
{"stackTrail":"paths:/payment-links:post:responses:200:content:application/json:schema:properties:payments","oasType":"schema","type":"unknown"}
callback_urlstring
{"stackTrail":"paths:/payment-links:post:responses:200:content:application/json:schema:properties:installments_plan","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/payment-links:post:responses:200:content:application/json:schema:properties:customer_payer","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/payment-links:post:responses:200:content:application/json:schema:properties:taxes","oasType":"schema","type":"unknown"}
account_idstring
checkout_urlstring
payments_numberinteger
merchant_imagestring

Example response

{
  "id": "555933df-4eed-4af4-ae83-a32072ef34af",
  "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,
  "payment_method_types": [
    "CARD"
  ],
  "callback_url": "https://checkout.sandbox.y.uno/payment/status",
  "additional_data": {
    "device": {
      "locale": "es-CL"
    },
    "payer_risk_data": {
      "login_platform": "WEB",
      "account_creation_date": "20191005"
    }
  },
  "account_id": "493e9374-510a-4201-9e09-de669d75f256",
  "checkout_url": "https://checkout.sandbox.y.uno/payment?session=2f6d9754-43d0-4dca-b023-6aba4b107179"
}