Validate a recipient

Checks that a recipient’s account exists and finds the name it’s registered to, so you can show your user a “Pay Jane Wanjiku?” screen before they send. Bank accounts must exist and have a name. For phone numbers, tills, and paybills, we may not find a name even when the number is fine.

Endpoint

POST https://merchant.minisend.xyz/api/offramp/validate-account

Authorization: Bearer ms_live_your_key_here

Requires the offramp scope.

Body

string

required

KES, NGN, GHS, or UGX. This decides which recipient fields you need.

object

required

Who you want to pay. See recipients for the fields.

Example

curl -X POST https://merchant.minisend.xyz/api/offramp/validate-account \
  -H "Authorization: Bearer ms_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "NGN",
    "recipient": {
      "account_name": "Chidi Okafor",
      "institution": "GTBINGLA",
      "account_number": "0123456789"
    }
  }'

const res = await fetch('https://merchant.minisend.xyz/api/offramp/validate-account', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ms_live_your_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    currency: 'NGN',
    recipient: {
      account_name: 'Chidi Okafor',
      institution: 'GTBINGLA',
      account_number: '0123456789',
    },
  }),
});

const { valid, recipient_name } = await res.json();

Response (200)

{
  "valid": true,
  "recipient_name": "CHIDI OKAFOR"
}

boolean

required

The account exists and can receive payouts.

string | null

required

The name the account is registered to, or null when the account is fine but we couldn’t find a name. That’s common for phone numbers. Show the name to your user before they confirm.

Invalid account (422)

{
  "valid": false,
  "error": "Recipient validation failed. Confirm the account details and try again."
}

Errors

Status	Meaning
`400`	We don’t support that currency, or the recipient fields aren’t right
`403`	Off-ramp isn’t switched on for your account yet
`422`	The account didn’t pass our check. You get `valid: false` and an `error` message

Overview

Endpoints

Off-ramp endpoints

Onramp endpoints

Wallet API endpoints

Validate a recipient

Endpoint

Body

Example

Response (200)

Invalid account (422)

Errors

​Endpoint

​Body

​Example

​Response (200)

​Invalid account (422)

​Errors

Endpoint

Body

Example

Response (200)

Invalid account (422)

Errors