Skip to content

Get the currently authenticated merchant's IPS onboarding status

Self-service counterpart of the admin status endpoint — resolves the merchant from the bearer token. Gate consumers (payment widget, merchant portal) should key on the computed `onboarded` field. Latency-optimized: a locally recorded successful onboarding answers without the live Central Bank lookup; only unproven merchants pay for the CAS round-trip.

GET https://api.leapa.co/v2/ips/onboard-merchant/status

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/onboard-merchant/status" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "merchant_id": "mer_1b47d0e9ca",
  "onboarded": false,
  "local_status": "success",
  "ips_customer_id": "cus_3d8e51fa20",
  "ips_alias_id": "+25779123456",
  "ips_account_id": "acc_62f3a8d15b",
  "ips_account_id_test": "00012345678901",
  "mobile": "string",
  "leapa_balance_account_id": "acc_62f3a8d15b",
  "last_error": "string",
  "cas_customer_exists": false,
  "cas_customer_status": "string",
  "cas_record_id": "string",
  "cas_alias_count": 0,
  "cas_account_count": 0
}

Response

application/json
  • merchant_idstring
  • onboardedboolean
  • local_statusstring
    Allowed values:successpartialfailed
  • ips_customer_idstring
  • ips_alias_idstring
  • ips_account_idstring
  • ips_account_id_teststring
  • mobilestring
  • leapa_balance_account_idstring
  • last_errorstring
  • cas_customer_existsboolean
  • cas_customer_statusstring
  • cas_record_idstring
  • cas_alias_countinteger<int32>
  • cas_account_countinteger<int32>

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/onboard-merchant/status" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "merchant_id": "mer_1b47d0e9ca",
  "onboarded": false,
  "local_status": "success",
  "ips_customer_id": "cus_3d8e51fa20",
  "ips_alias_id": "+25779123456",
  "ips_account_id": "acc_62f3a8d15b",
  "ips_account_id_test": "00012345678901",
  "mobile": "string",
  "leapa_balance_account_id": "acc_62f3a8d15b",
  "last_error": "string",
  "cas_customer_exists": false,
  "cas_customer_status": "string",
  "cas_record_id": "string",
  "cas_alias_count": 0,
  "cas_account_count": 0
}