Skip to content
Leapa
Leapa.co
Sign in

List the accounts linked to a customer's IPS phone alias

GET https://api.leapa.co/v2/ips/alias-accounts

This endpoint needs your API key

Send it as a bearer token in the Authorization header. A request without one is answered with 401. See Authentication for where to find your key and how to keep it secret.

Request

curl -X GET "https://api.leapa.co/v2/ips/alias-accounts?alias=+25779123456" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "alias": "+25779123456",
  "resolved": false,
  "accounts": [
    {
      "account": "00012345678901",
      "bank_bic": "BIBUBIBI",
      "bank_name": "Jeanne Ndayishimiye",
      "brand": "string",
      "name": "Jeanne Ndayishimiye",
      "account_type": "00012345678901",
      "currency": "BIF",
      "is_default": false
    }
  ],
  "message": "Request sent to the payer"
}

Query parameters

Appended to the URL after a `?`.

  • aliasstringrequired
    Example:+25779123456

Response

application/json
  • aliasstring
  • resolvedboolean
  • accountsarray of AliasAccount
  • messagestring

Status codes

  • 200OK
  • 400Bad request
  • 401Unauthorized
  • 402Payment required
  • 403Forbidden
  • 404Not found
  • 428Precondition required
  • 500Server error

Request

curl -X GET "https://api.leapa.co/v2/ips/alias-accounts?alias=+25779123456" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "alias": "+25779123456",
  "resolved": false,
  "accounts": [
    {
      "account": "00012345678901",
      "bank_bic": "BIBUBIBI",
      "bank_name": "Jeanne Ndayishimiye",
      "brand": "string",
      "name": "Jeanne Ndayishimiye",
      "account_type": "00012345678901",
      "currency": "BIF",
      "is_default": false
    }
  ],
  "message": "Request sent to the payer"
}