v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Retrieve Payment Link

get/payment-links/{code}

Path parameters

codestring required

The code of the payment link (UUID, 36 chars).

Response

200

codestring

countrystring

statusstring

descriptionstring

split_payment_methodsboolean

payment_method_typesstring[]

one_time_useboolean

callback_urlstring

{"stackTrail":"paths:/payment-links/{code}:get:responses:200:content:application/json:schema:properties:installments_plan","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/payment-links/{code}:get:responses:200:content:application/json:schema:properties:customer_payer","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/payment-links/{code}:get:responses:200:content:application/json:schema:properties:taxes","oasType":"schema","type":"unknown"}

organization_codestring

account_codestring

checkout_urlstring

payments_numberinteger

merchant_imagestring

Example response

{
  "code": "aace3f6d-e26d-45d0-9a4f-66523909ddf9",
  "country": "US",
  "availability": {
    "start_at": "2023-01-15T14:00:12Z",
    "finish_at": "2023-10-29T14:00:12Z"
  },
  "status": "CREATED",
  "description": "PRUEBA PAYMENT LINK 10/07",
  "amount": {
    "currency": "USD",
    "value": 5000
  },
  "metadata": [
    {
      "key": "some key",
      "value": "some value"
    }
  ],
  "payment_method_types": [
    "PSE"
  ],
  "one_time_use": true,
  "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"
    }
  },
  "organization_code": "b887a970-9722-44fe-ab17-106bf1b93577",
  "account_code": "8147da44-4de9-48ff-a194-51b2cd7d2a03",
  "checkout_url": "https://checkout.sandbox.y.uno/payment?session=ac63a0d7-b2d7-4e72-9062-2e2e3a448359"
}