Resolve Payment Method - Afriex Business API

Afriex SDK

TypeScript

const accountInfo = await afriex.paymentMethods.resolveAccount({
  channel: "BANK_ACCOUNT",
  accountNumber: "1234567890",
  institutionCode: "044",
  countryCode: "NG",
});

// Returns: { recipientName, recipientEmail, recipientPhone }

curl --request GET \ 
  --url https://sandbox.api.afriex.com/api/v1/payment-method/resolve \ 
  --header 'x-api-key: <api-key>'

import requests

url = "https://sandbox.api.afriex.com/api/v1/payment-method/resolve"

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/resolve', 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/resolve",
  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/resolve"

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/resolve")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

200

{
  "data": {
    "recipientName": "John Doe",
    "institutionName": "GUARANTY TRUST BANK",
    "institutionCode": "000013"
  }
}

Resolve payment method user information for bank accounts or mobile money. This endpoint validates and retrieves recipient details based on account number and institution code.

Authorizations

• x-api-key (string, header, required): Static business API key issued from the dashboard. Permissions are scoped per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key lacking necessary permissions will be rejected with a 403 Forbidden response.

Headers

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

Query Parameters

• channel (enum, required): The payment method channel to resolve. Options: MOBILE_MONEY, BANK_ACCOUNT.
• accountNumber (string): Bank account number (for BANK_ACCOUNT channel) or phone number (for MOBILE_MONEY channel).
• institutionCode (string): Bank code required for BANK_ACCOUNT channel.
• countryCode (enum, required): The ISO 3166-1 alpha-2 country code. Accepted values depend on channel; BANK_ACCOUNT supports only NG and GH.

Available Options for countryCode:

• NG
• GH
• Additional codes available for MOBILE_MONEY channel.