Cancel a payment link (pay scope) — only a pending link is cancellable

curl --request PATCH \
  --url https://api.blankfx.org/public/v1/payment-links/{id} \
  --header 'BFX-API-KEY: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

url = "https://api.blankfx.org/public/v1/payment-links/{id}"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "BFX-API-KEY": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Idempotency-Key': '<idempotency-key>', 'BFX-API-KEY': '<api-key>'}
};

fetch('https://api.blankfx.org/public/v1/payment-links/{id}', 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.blankfx.org/public/v1/payment-links/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "BFX-API-KEY: <api-key>",
    "Idempotency-Key: <idempotency-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.blankfx.org/public/v1/payment-links/{id}"

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("BFX-API-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.patch("https://api.blankfx.org/public/v1/payment-links/{id}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("BFX-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blankfx.org/public/v1/payment-links/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["BFX-API-KEY"] = '<api-key>'

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

PATCH

payment-links

{id}

Cancel a payment link (pay scope) — only a pending link is cancellable

curl --request PATCH \
  --url https://api.blankfx.org/public/v1/payment-links/{id} \
  --header 'BFX-API-KEY: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

import requests

url = "https://api.blankfx.org/public/v1/payment-links/{id}"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "BFX-API-KEY": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Idempotency-Key': '<idempotency-key>', 'BFX-API-KEY': '<api-key>'}
};

fetch('https://api.blankfx.org/public/v1/payment-links/{id}', 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.blankfx.org/public/v1/payment-links/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_HTTPHEADER => [
    "BFX-API-KEY: <api-key>",
    "Idempotency-Key: <idempotency-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.blankfx.org/public/v1/payment-links/{id}"

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("BFX-API-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.patch("https://api.blankfx.org/public/v1/payment-links/{id}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("BFX-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blankfx.org/public/v1/payment-links/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["BFX-API-KEY"] = '<api-key>'

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

Authorizations

BFX-API-KEY

string

header

required

Ed25519 request signing. Send three headers: BFX-API-KEY (your key_id), BFX-TIMESTAMP (unix seconds; rejected if more than 30s from server time), and BFX-SIGNATURE = base64(Ed25519_sign(privateKey, ${timestamp}\n${METHOD}\n${requestTarget}\n${sha256(body)})) where requestTarget is the path including any query string. The server verifies the signature against your registered public key; no shared secret exists.

Headers

Idempotency-Key

string

required

Any unique string (e.g. a UUID). Required: a request without it returns 400 idempotency_key_required. The same key on the same route within 24h replays the original response.

Path Parameters

string

required

Response

Cancelled (repeat cancel is an idempotent no-op)

Get started

Guides

Endpoints

Cancel a payment link (pay scope) — only a pending link is cancellable

Authorizations

Headers

Path Parameters

Response