Cancel an order

Only works while the order is DRAFT or AWAITING_DEPOSIT — before funds are in transit. 400 for any later status (cancelling after funds move forfeits the conversion cost already incurred). No request body.

POST /api/v2/payouts/{batchId}/orders/{orderId}/cancel

Cancel an order

cURL

curl --request POST \
  --url https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fee_type": "OUR",
  "purpose_code": "SNTR",
  "beneficiary_amount": "<string>",
  "beneficiary_currency": "<string>",
  "source_currency": "USDT",
  "status": "DRAFT",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "fee_amount": "<string>",
  "source_amount": "<string>",
  "failure_message": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "client_reference": "<string>"
}

Authorizations

x-api-key · string · header · required

API key for authentication

Authorization · string · header · required

ES256 JWT signed by the private key registered to the API key above. Claims: sub (=API key), uri, nbf, iat, exp, and bodyHash (HMAC-SHA512 of uri + rawBody + nbf using a shared secret, base64).

Path Parameters

batchId · string<uuid> · required

ID of the batch

orderId · string<uuid> · required

ID of the order

Response

200

application/json

The cancelled order, now CANCELLED_EXPIRED

id · string<uuid> · required

batch_id · string<uuid> · required

sender_profile_id · string<uuid> · required

beneficiary_profile_id · string<uuid> · required

fee_type · enum<string> · required

Available options: OUR, SHA

purpose_code · enum<string> · required

SNTR Transfer of the same name · GDSP Payment · LGST Logistics costs · ADVT Advertising costs · TECH Technical service fee · CLUD Cloud as a Service · RENT Rental costs · UTIL Utility expenses · LAWF Law firm fees · ACCT Accounting expenses · CONS Consultancy fees · SPON Sponsorship costs · INVT Investment & financial management

Available options: SNTR, GDSP, LGST, ADVT, TECH, CLUD, RENT, UTIL, LAWF, ACCT, CONS, SPON, INVT

beneficiary_amount · string · required

beneficiary_currency · string · required

source_currency · string · required

Always "USDT" today

Example:

"USDT"

status · enum<string> · required

DRAFT: created and quoted, still editable · AWAITING_DEPOSIT: confirmed, funding in progress (expires_at is the deadline) · DEPOSIT_RECEIVED: funding landed · PAYING_BENEFICIARY: beneficiary payment in flight · COMPLETED, FAILED, CANCELLED_EXPIRED: terminal.

Available options: DRAFT, AWAITING_DEPOSIT, DEPOSIT_RECEIVED, PAYING_BENEFICIARY, COMPLETED, FAILED, CANCELLED_EXPIRED

created_at · string<date-time> · required

updated_at · string<date-time> · required

fee_amount · string | null

Wire fee only, in beneficiary_currency.

source_amount · string | null

The number that matters for funding — already reflects everything the client is responsible for. Deliberately excludes the effective USDT↔fiat rate or anything that would let Mansa's own margin be back-computed.

failure_message · string | null

Present only when status is FAILED. Safe to display.

expires_at · string<date-time> | null

Set once the order reaches AWAITING_DEPOSIT.

client_reference · string | null