Skip to content
Leapa
Leapa.co
Sign in

Onboard the currently authenticated merchant to IPS

Self-service IPS onboarding triggered from the merchant portal — for example after the merchant adds their first payout account. Resolves the merchant from the bearer token. Idempotent on merchantId.

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

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 POST "https://api.leapa.co/v2/ips/onboard-merchant" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "merchant_id": "mer_1b47d0e9ca",
  "status": "success",
  "message": "Request sent to the payer",
  "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"
}

Response

application/json
  • merchant_idstring
  • statusstring
    Allowed values:successpartialfailed
  • messagestring
  • ips_customer_idstring
  • ips_alias_idstring
  • ips_account_idstring
  • ips_account_id_teststring
  • mobilestring
  • leapa_balance_account_idstring

Status codes

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

Request

curl -X POST "https://api.leapa.co/v2/ips/onboard-merchant" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "merchant_id": "mer_1b47d0e9ca",
  "status": "success",
  "message": "Request sent to the payer",
  "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"
}