Delete Payment Method - Afriex Business API

Afriex SDK

TypeScript

await afriex.paymentMethods.delete("payment-method-id");

curl --request DELETE \
  --url https://sandbox.api.afriex.com/api/v1/payment-method/{paymentMethodId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://sandbox.api.afriex.com/api/v1/payment-method/{paymentMethodId}"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://sandbox.api.afriex.com/api/v1/payment-method/{paymentMethodId}', 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://sandbox.api.afriex.com/api/v1/payment-method/{paymentMethodId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "x-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://sandbox.api.afriex.com/api/v1/payment-method/{paymentMethodId}"

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

req.Header.Add("x-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.delete("https://sandbox.api.afriex.com/api/v1/payment-method/{paymentMethodId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.afriex.com/api/v1/payment-method/{paymentMethodId}")

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

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

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

Response

• 200 successful
• Response Body:

  {}
  

Remove a payment method from the system

This action cannot be undone.

Authorizations

• x-api-key
  • Type: string
  • Location: header
  • Required: Yes
  • Description: Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a 403 Forbidden response; an unrecognized, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

• x-api-signature
  • Type: string
  • Description: Signature of the request payload, used for request authentication where payload signing is enabled for your business.
• x-api-version
  • Type: string
  • Description: API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable.

Path Parameters

• paymentMethodId
  • Type: string
  • Required: Yes
  • Description: The unique identifier of the payment method.

Response

• Type: application/json
• Description: Payment method deleted successfully. The response is of type object.

Get Payment Method List Institutions