---
title: "Resolve payment method recipient by account number"
method: GET
path: "/api/v1/payment-method/resolve"
tags: ["Payment Methods"]
---

# Resolve payment method recipient by account number

`GET /api/v1/payment-method/resolve`

## Request

- Base URL: `https://sandbox.api.afriex.com`
- URL: `https://sandbox.api.afriex.com/api/v1/payment-method/resolve`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/payment-method/resolve/get.ts> (a function with typed inputs; its response is checked against the schema)

Resolves payment method user information for bank accounts or mobile money.

## Query parameters

- `channel` 'MOBILE_MONEY' | 'BANK_ACCOUNT', required
- `accountNumber` string
- `institutionCode` string, required
- `countryCode` string, required

## Response `200`

Payment method resolved successfully.

- object
  - `data` PaymentMethodResolveResponse
    - `recipientName` string: The resolved name on the account.
    - `institutionName` string: The name of the resolved bank or mobile money provider.
    - `institutionCode` string: The code of the resolved bank or mobile money provider.

## Other responses

- `400`: Invalid request parameters, the account could not be resolved, or account name lookup is not available for the channel in that country. When it is not available, collect the recipient name yourself.
- `401`: Unauthorized - Invalid business API key.
- `500`: Server error.
- `503`: Temporarily unavailable: an upstream service failed or timed out, or the API is momentarily offline. Retry with backoff and honour the Retry-After header when present.

---

[API](https://skmtc.dev/afriex/apis/afriex-business-api.md) - [All operations](https://skmtc.dev/afriex/apis/afriex-business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/afriex/apis/afriex-business-api/revisions/d94198b6c256?raw)