Endpoints

Create a merchant

Creates a new merchant profile under the calling master. The merchant is always created Pending (status = -1); it cannot process payments until Ops reviews and activates it. Creating a merchant also sends an onboarding notification to Ops — opsnotified reports whether that notification went out.

The owning master is taken from the token; there is no resellerid field. Provide copy_settings_from to seed the new merchant's EFT settings from an existing merchant in your own scope (applied after the default seed).

POST
/v1/merchants

Authorization

bearerAuth
AuthorizationBearer <token>

A partner API token issued to a Master Account. Send Authorization: Bearer <token> on every request. Tokens are issued and revoked by a SuperAdmin in the backoffice, not through this API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

{
  "merchantid": 10544,
  "merchantcode": "ME10544",
  "status": -1,
  "statuslabel": "pending",
  "settingscopied": null,
  "opsnotified": true
}
{
  "error": {
    "code": "validation_failed",
    "message": "MINIMUM_EFT_AMOUNT must be numeric.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "A valid bearer token is required.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the period indicated.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}

On this page