Endpoints

Update a merchant

Updates merchant profile fields. Every field is optional; only supplied fields are written.

The optional status field permits only Active (1) or Suspended (0), and only when the merchant is already at status >= 0. A partner can never activate a Pending or Draft merchant; that is Ops-only. There are no fee or billing fields.

PATCH
/v1/merchants/{merchantId}

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

Path Parameters

merchantId*integer

The merchant id. Must belong to the calling master, or the request is 404.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

{
  "merchantid": 0,
  "merchantcode": "string",
  "apitoken": "string",
  "status": 0,
  "statuslabel": "string",
  "businessname": "string",
  "businesslegalname": "string",
  "businessemail": "string",
  "businesstelephone": "string",
  "contactfirstname": "string",
  "contactsurname": "string",
  "contactemail": "string",
  "datecreated": "2019-08-24T14:15:22Z"
}
{
  "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": "not_found",
    "message": "Merchant not found.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the period indicated.",
    "requestid": "8f3c1a9b2d7e4f60"
  }
}

On this page