List Payment Methods - Afriex Business API

Afriex SDK

TypeScript

const response = await afriex.paymentMethods.list({
  page: 1,
  limit: 20,
});

curl --request GET \
  --url 'https://sandbox.api.afriex.com/api/v1/payment-method?limit=10&capabilities=WITHDRAW&status=active%2Cpending' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://sandbox.api.afriex.com/api/v1/payment-method?limit=10&capabilities=WITHDRAW&status=active%2Cpending"

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

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

print(response.text)

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

fetch('https://sandbox.api.afriex.com/api/v1/payment-method?limit=10&capabilities=WITHDRAW&status=active%2Cpending', 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?limit=10&capabilities=WITHDRAW&status=active%2Cpending",\\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  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?limit=10&capabilities=WITHDRAW&status=active%2Cpending"

req, _ := http.NewRequest("GET", 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.get("https://sandbox.api.afriex.com/api/v1/payment-method?limit=10&capabilities=WITHDRAW&status=active%2Cpending")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.afriex.com/api/v1/payment-method?limit=10&capabilities=WITHDRAW&status=active%2Cpending")

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

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

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

Response

{
  "data": [
    {
      "paymentMethodId": "6936b8774f987b2994865b73",
      "channel": "BANK_ACCOUNT",
      "customerId": "6922e4520a53e858ab42efa8",
      "institution": {
        "institutionCode": "000013",
        "institutionName": "GTBank"
      },
      "accountName": "John Doe",
      "accountNumber": "1234567890",
      "countryCode": "NG"
    },
    {
      "paymentMethodId": "6936b8e54f987b2994865b8b",
      "channel": "BANK_ACCOUNT",
      "customerId": "6928515c6befd180bc451622",
      "institution": {
        "institutionCode": "000017",
        "institutionName": "WEMA BANK"
      },
      "accountName": "Test Account",
      "accountNumber": "1213131313",
      "countryCode": "NG"
    }
  ],
  "total": 1006,
  "page": 0
}

Authorizations

x-api-key

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

x-api-version

Query Parameters

Response

Success Response

data

page

total