Orders

Cancel order

Partner cancels the order.

Esta página aún no está disponible en tu idioma.

POSThttps://api.maple.inc/v1/orders/{orderId}/cancelAPI key

Authorization

Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

Parameters

orderId string path required

Request body

application/json, required.

reason string or null

Responses

200 OK

object string required

Always order_decision.
order_id string required
decision string required

One of accept, deny, ready, complete, cancel, status.
status string required

Always received.

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
404 Not found DeveloperApiNotFound
429 Too many requests DeveloperApiRateLimited

Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.

Cancel order

curl "$MAPLE_BASE/orders/ord_123/cancel" \
  -H "Authorization: Bearer $MAPLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"string"}'

import os
import requests

r = requests.post(
    f"{os.environ['MAPLE_BASE']}/orders/ord_123/cancel",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    json={
        "reason": "string",
    },
    timeout=30,
)
r.raise_for_status()
print(r.json())

const res = await fetch(`${process.env.MAPLE_BASE}/orders/ord_123/cancel`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": "string"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "order_decision",
  "order_id": "ord_123",
  "decision": "accept",
  "status": "received"
}

{
  "_tag": "DeveloperApiBadRequest",
  "code": "string",
  "message": "string",
  "feedback": "string"
}