Deactivate a payment instrument

DELETE/v0.1/customers/{customer_id}/payment-instruments/{token}

Deactivates an identified card payment instrument resource for a customer.

OAuth scopes: Requires one of: payment_instruments, customers.write.

Authorization

Use one of the following alternatives:

apiKey
oauth2 with scopes payment_instruments
oauth2 with scopes customers.write

Authorization guide

Path parameters

customer_idstringrequired
The customer_id you supplied when creating the customer.

Example: "831ff8d4cd5958ab5670"
tokenstringrequired
Unique token identifying the card saved as a payment instrument resource.

Example: "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3"

Responses

204

Returns an empty response body when the operation succeeds.

Returns an empty response.

400application/json

The request is invalid.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

401application/json

The request is not authorized.

typestringrequired
format: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestring
format: uri
A URI reference that identifies the specific occurrence of the problem.

403application/json

The request is authenticated but not permitted for this operation.

error_messagestring
Short description of the error.

Example: "request_not_allowed"
error_codestring
Platform code for the error.

Example: "FORBIDDEN"
status_codestring
HTTP status code for the error.

Example: "403"

404application/json

The requested resource does not exist.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

DELETE

Deactivate a payment instrument

Code sample

curl --request DELETE \
  --url https://api.sumup.com/v0.1/customers/831ff8d4cd5958ab5670/payment-instruments/bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3 \
  --header 'Authorization: Bearer <token>'

import SumUp from "@sumup/sdk";

async function main() {
  const client = new SumUp({ apiKey: "sup_sk_your_api_key" });

  const result = await client.customers.deactivatePaymentInstrument(
    "831ff8d4cd5958ab5670",
    "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3"
  );
  console.log(result);
}

main().catch(console.error);

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Customers.DeactivatePaymentInstrumentAsync(
            "example-id",
            "example");

        Console.WriteLine(response.StatusCode);
    }
}

import com.sumup.sdk.SumUpClient;

public final class DeactivatePaymentInstrumentSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    client.customers().deactivatePaymentInstrument(
            "831ff8d4cd5958ab5670",
            "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3"
        );
  }
}

import os

import sumup

client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])
client.customers.deactivate_payment_instrument(
    "831ff8d4cd5958ab5670",
    "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3",
)

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

$sumup = new \SumUp\SumUp('sup_sk_your_api_key');

$result = $sumup->customers()->deactivatePaymentInstrument(
    '831ff8d4cd5958ab5670',
    'bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3',
);

var_dump($result);

package main

import (
	"context"

	"github.com/sumup/sumup-go"
)

func main() {
	client := sumup.NewClient()
	if err := client.Customers.DeactivatePaymentInstrument(context.TODO(), "831ff8d4cd5958ab5670", "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3"); err != nil {
		panic(err.Error())
	}
}

use sumup::{Authorization, Client};
#[tokio::main]
async fn main() {
    let client = Client::default()
        .with_authorization(Authorization::api_key("sup_sk_test_..."));
    let response = client
        .customers()
        .deactivate_payment_instrument("CUSTOMER_ID", "PAYMENT_INSTRUMENT_TOKEN")
        .await
        .expect("deactivate_payment_instrument request failed");
    println!("{response:#?}");
}

Response example

{
  "error_code": "INVALID_REQUEST",
  "message": "bad request"
}

{
  "detail": "Unauthorized.",
  "status": 401,
  "title": "Unauthorized",
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
  "type": "https://developer.sumup.com/problem/unauthorized"
}

{
  "error_message": "request_not_allowed",
  "error_code": "FORBIDDEN",
  "status_code": "403"
}

{
  "error_code": "NOT_FOUND",
  "message": "Resource not found"
}