Cancel Payment Link

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>'

import requests

url = "https://api-sandbox.y.uno/v1/payment-links/{code}/cancel"

headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/payment-links/{code}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/payment-links/{code}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/payment-links/{code}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/payment-links/{code}/cancel")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/payment-links/{code}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": ""
}

{
  "code": "INVALID_REQUEST",
  "messages": [
    "Invalid request"
  ]
}

POST

payment-links

{code}

cancel

Cancel Payment Link

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>'

import requests

url = "https://api-sandbox.y.uno/v1/payment-links/{code}/cancel"

headers = {
    "public-api-key": "<api-key>",
    "private-secret-key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'public-api-key': '<api-key>', 'private-secret-key': '<api-key>'}
};

fetch('https://api-sandbox.y.uno/v1/payment-links/{code}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/payment-links/{code}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "private-secret-key: <api-key>",
    "public-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/payment-links/{code}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("public-api-key", "<api-key>")
	req.Header.Add("private-secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.y.uno/v1/payment-links/{code}/cancel")
  .header("public-api-key", "<api-key>")
  .header("private-secret-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/payment-links/{code}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["public-api-key"] = '<api-key>'
request["private-secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": ""
}

{
  "code": "INVALID_REQUEST",
  "messages": [
    "Invalid request"
  ]
}

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

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:

""

⌘I