Cancel Payment Link

Cancel an existing payment link by its code.

POST /payment-links/{code}/cancel

Cancel Payment Link

cURL

curl --request POST \
  --url https://api-sandbox.y.uno/v1/payment-links/{code}/cancel \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>'

200

{
  "code": "aace3f6d-e26d-45d0-9a4f-66523909ddf9",
  "country": "US",
  "availability": {
    "start_at": "2023-01-15T14:00:12Z",
    "finish_at": "2023-10-29T14:00:12Z"
  },
  "status": "CANCELED",
  "description": "PRUEBA PAYMENT LINK 10/07",
  "amount": {
    "currency": "USD",
    "value": 5000
  },
  "metadata": [
    {
      "key": "some key",
      "value": "some value"
    }
  ],
  "split_payment_methods": false,
  "payment_method_types": [
    "PSE"
  ],
  "one_time_use": true,
  "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
  },
  "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",
  "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

Path Parameters

code · string · required

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

Response

200

application/json

200

code · string

Example:

"aace3f6d-e26d-45d0-9a4f-66523909ddf9"

country · string

Example:

"US"

availability · object

Show child attributes

status · string

Example:

"CANCELED"

description · string

Example:

"PRUEBA PAYMENT LINK 10/07"

amount · object

Show child attributes

metadata · object[]

Show child attributes

split_payment_methods · boolean · default: true

Example:

false

payment_method_types · string[]

one_time_use · boolean · default: true

Example:

true

callback_url · string

Example:

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

installments_plan · any

customer_payer · any

taxes · any

additional_data · object

Show child attributes

organization_code · string

Example:

"b887a970-9722-44fe-ab17-106bf1b93577"

account_code · string

Example:

"8147da44-4de9-48ff-a194-51b2cd7d2a03"

checkout_url · string

Example:

"https://checkout.sandbox.y.uno/payment?session=ac63a0d7-b2d7-4e72-9062-2e2e3a448359"

payments_number · integer · default: 0

Example:

0

merchant_image · string

Example:

""