Endpoints

Delete a receiving account

Soft-deletes a receiving account (sets it disabled). An account referenced by an active payment route cannot be deleted; remove it from routing first.

DELETE
/v1/merchants/{merchantId}/receiving-accounts/{accountId}

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.

accountId*integer

The receiving account id. Must belong to the merchant.

Response Body

application/json

application/json

application/json

application/json

application/json

{
  "merchantid": 10544,
  "updated": 1
}
{
  "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