Cancel Payment Method

curl --request POST \
  --url https://api.prod.finverse.net/payment_methods/{paymentMethodId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prod.finverse.net/payment_methods/{paymentMethodId}/cancel"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/payment_methods/{paymentMethodId}/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.prod.finverse.net/payment_methods/{paymentMethodId}/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.prod.finverse.net/payment_methods/{paymentMethodId}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/payment_methods/{paymentMethodId}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "card": {
    "card_details": {
      "acquirer_authorization_reference": "R7RRPSMPR5P",
      "brand": "Visa",
      "brand_product_name": "visa",
      "card_number_alias": "F495225511395777",
      "collection_entity_name": "LE32CLG223226Q5N3BCX45QNS",
      "country": "NL",
      "expiry_month": 3,
      "expiry_year": 2030,
      "fingerprint": "5ePOmfH7G5irogopQi8b1XfF4G3CF",
      "finverse_authorization_reference": "FC260415XP40",
      "last4": "1111",
      "processor_details": {
        "auth_code": "070240",
        "processor_id": "ADYEN",
        "processor_reference": "PTQK3MZ7F9SRCTV5",
        "token_id": "WV947F3N9PJ3JWV5"
      },
      "recurring_payment_mode": "NON_RECURRING"
    },
    "created_at": "2026-04-15T07:39:00.921Z",
    "recipient_account": {
      "account_id": "01K3NA2VWQCX4GKKTRH5RQRGQ2",
      "account_type": "SETTLEMENT_ACCOUNT"
    },
    "risk_data": {
      "processor_risk_data": {
        "browser_type": "Chrome",
        "device_type": "Other",
        "shopper_country": "HK",
        "shopper_ip": "121.202.204.206",
        "shopper_locale": "en-US"
      }
    },
    "status": "CANCELLED",
    "updated_at": "2026-04-15T07:44:42.648Z"
  },
  "integration_metadata": {
    "adyen_metadata": {
      "auth_code": "070240",
      "payment_method_id": "WV947F3N9PJ3JWV5",
      "psp_reference": "PTQK3MZ7F9SRCTV5",
      "recurring_processing_model": "UnscheduledCardOnFile"
    },
    "integration_id": "ADYEN"
  },
  "payment_method_id": "01KP818HDB4CVFQEXNCV7AMNH3",
  "payment_method_type": "CARD"
}

Payment methods

Cancel Payment Method

Cancel a Payment Method (using a specific payment_method_id). This sets the Payment Method status to CANCELLED and Finverse will no longer process any payments for the Payment Method.

Cancellation is optional.

Cancellation will fail if the Payment Method is non-cancellable (e.g. because it is still being processed), or if the Payment Method has a processing Payment.

Authorization: customer_token

Response fields

The response is a Payment Method object, or an error object if the Payment Method is not cancellable (e.g. payment is already processing).

Refer to Payment Method object data model in GET /payment_users/{{user_id}}/payment_methods

POST

payment_methods

{paymentMethodId}

cancel

Cancel Payment Method

curl --request POST \
  --url https://api.prod.finverse.net/payment_methods/{paymentMethodId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prod.finverse.net/payment_methods/{paymentMethodId}/cancel"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prod.finverse.net/payment_methods/{paymentMethodId}/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.prod.finverse.net/payment_methods/{paymentMethodId}/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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.prod.finverse.net/payment_methods/{paymentMethodId}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prod.finverse.net/payment_methods/{paymentMethodId}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "card": {
    "card_details": {
      "acquirer_authorization_reference": "R7RRPSMPR5P",
      "brand": "Visa",
      "brand_product_name": "visa",
      "card_number_alias": "F495225511395777",
      "collection_entity_name": "LE32CLG223226Q5N3BCX45QNS",
      "country": "NL",
      "expiry_month": 3,
      "expiry_year": 2030,
      "fingerprint": "5ePOmfH7G5irogopQi8b1XfF4G3CF",
      "finverse_authorization_reference": "FC260415XP40",
      "last4": "1111",
      "processor_details": {
        "auth_code": "070240",
        "processor_id": "ADYEN",
        "processor_reference": "PTQK3MZ7F9SRCTV5",
        "token_id": "WV947F3N9PJ3JWV5"
      },
      "recurring_payment_mode": "NON_RECURRING"
    },
    "created_at": "2026-04-15T07:39:00.921Z",
    "recipient_account": {
      "account_id": "01K3NA2VWQCX4GKKTRH5RQRGQ2",
      "account_type": "SETTLEMENT_ACCOUNT"
    },
    "risk_data": {
      "processor_risk_data": {
        "browser_type": "Chrome",
        "device_type": "Other",
        "shopper_country": "HK",
        "shopper_ip": "121.202.204.206",
        "shopper_locale": "en-US"
      }
    },
    "status": "CANCELLED",
    "updated_at": "2026-04-15T07:44:42.648Z"
  },
  "integration_metadata": {
    "adyen_metadata": {
      "auth_code": "070240",
      "payment_method_id": "WV947F3N9PJ3JWV5",
      "psp_reference": "PTQK3MZ7F9SRCTV5",
      "recurring_processing_model": "UnscheduledCardOnFile"
    },
    "integration_id": "ADYEN"
  },
  "payment_method_id": "01KP818HDB4CVFQEXNCV7AMNH3",
  "payment_method_type": "CARD"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

paymentMethodId

string

required

The payment method id

Minimum string length: 1

Response

Success (Card)

card

object

Card object Included only if payment_method_type = CARD.

Show child attributes

integration_metadata

object

Show child attributes

mandate

object

Mandate object. Refer to Mandate object data model in GET /mandates/{mandate_id}. Included only if payment_method_type = MANDATE.

Show child attributes

payment_method_id

string

Finverse unique ID for this payment method. If the Sender has autopay_consent = true , this ID can be used to trigger additional payments on-demand (see POST /payments).

payment_method_type

string

Type of payment method. Possible values: CARD, MANDATE.