API reference / Auth
Revoke a seller authorization
POST/open/v1/auth/revokeScope: No data scope
Service Endpoint Seller token not required
| Environment | Base URL + Path |
|---|---|
| Production | https://open.mallplus.ph/open/v1/auth/revoke |
| Sandbox | https://sandbox.open.mallplus.ph/open/v1/auth/revoke |
Common Signing and Seller Headers
| Header | Type | Required | Rules | Description |
|---|---|---|---|---|
| X-MallPlus-Partner-Id | string | Yes | Issued client ID for the calling app. | Identifies the partner app whose secret signs the request. |
| X-MallPlus-Timestamp | integer | Yes | Unix timestamp in seconds; default acceptance window is 90 seconds. | Prevents replay outside the allowed signing window. |
| X-MallPlus-Signature-Version | string | Yes | Use 3 for HMAC v3. | Selects the request signing algorithm. |
| X-MallPlus-Nonce | string | Yes | 32-64 lowercase hexadecimal characters, unique per request. | Replay-protection nonce included in the v3 signing base string. |
| X-MallPlus-Signature | string | Yes | HMAC-SHA256 over timestamp, client ID, method, path, canonical query, body hash, and nonce. | Cryptographic proof that the request was signed with the app secret. |
| X-MallPlus-Access-Token | string | Conditional | Required when the operation says seller token required. | Seller OAuth access token returned by the authorization flow. |
| X-MallPlus-Seller-Id | string | Conditional | Required when X-MallPlus-Access-Token is required. | Seller ID bound to the seller OAuth token. |
Parameters
This operation does not define path or query parameters in OpenAPI.
Request Body required
| Field | Type | Required | Rules | Description |
|---|---|---|---|---|
| client_id | string | Yes | Min length: 1 | Partner application client ID. |
| seller_id | string | Yes | Min length: 1 | Seller whose grant this applies to: the seller_id returned by POST /open/v1/auth/token (originally the seller_id query parameter on the consent redirect), or any seller_id from GET /open/v1/authorizations. |
Response Parameters
Success status: HTTP 200
| Field | Type | Rules | Description |
|---|---|---|---|
| success | enum | Allowed: true | Whether the request completed successfully. |
| data | RevokeAuthorizationData | No additional properties | Response or event payload for this schema. |
| data.revoked | boolean | - | True when an active authorization was revoked; false when there was no active grant to revoke. No affected-row count is exposed. |
Error Codes
| HTTP Status | Schema | Description |
|---|---|---|
| 400 | PlatformError400Response | Validation error, or a missing/malformed required signing header (BAD_REQUEST) |
| 401 | PlatformError401Response | Unauthorized — invalid credentials, invalid signature, or expired timestamp (TIMESTAMP_EXPIRED) |
| 403 | PlatformError403Response | Forbidden — insufficient scope |
| 413 | PlatformError413Response | The request body exceeds the endpoint payload limit |
| 429 | PlatformError429Response | The partner or endpoint rate limit has been exceeded |
| 503 | PlatformError503Response | A required platform or upstream dependency is temporarily unavailable |
This operation does not declare its own error.code list. Any operation can return the authentication, signing, scope, rate-limit and system codes listed in the Error code reference.
Request Example
# Sandbox: https://sandbox.open.mallplus.ph/open/v1/auth/revoke
curl -X POST "https://open.mallplus.ph/open/v1/auth/revoke" \
-H "X-MallPlus-Partner-Id: mp_partner_123" \
-H "X-MallPlus-Timestamp: 1786924800" \
-H "X-MallPlus-Signature-Version: 3" \
-H "X-MallPlus-Nonce: 4f8b9a0c4d5e6f708192a3b4c5d6e7f8" \
-H "X-MallPlus-Signature: <hex_hmac_sha256>" \
-H "Content-Type: application/json" \
--data '{
"client_id": "client_id_123",
"seller_id": "seller_id_123"
}'Response Example
{
"success": true,
"data": {
"revoked": true
}
}