Mansa Docs

Edit a draft order

curl --request PATCH \
  --url https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "beneficiary_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary_amount": "<string>",
  "beneficiary_currency": "<string>"
}
'

import requests

url = "https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId}"

payload = {
    "beneficiary_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "beneficiary_amount": "<string>",
    "beneficiary_currency": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    beneficiary_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    beneficiary_amount: '<string>',
    beneficiary_currency: '<string>'
  })
};

fetch('https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

{
  "statusCode": 400,
  "message": "sender is not ready"
}

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Sender not found"
}

{
  "statusCode": 422,
  "message": [
    "legal_name should not be empty",
    "country_code must be a valid ISO 3166-1 alpha-2 code"
  ]
}

{
  "statusCode": 429,
  "message": "Too many requests"
}

{
  "statusCode": 500,
  "message": "Internal server error"
}

PATCH

api

payouts

{batchId}

orders

{orderId}

Edit a draft order

curl --request PATCH \
  --url https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "beneficiary_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "beneficiary_amount": "<string>",
  "beneficiary_currency": "<string>"
}
'

import requests

url = "https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId}"

payload = {
    "beneficiary_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "beneficiary_amount": "<string>",
    "beneficiary_currency": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    beneficiary_profile_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    beneficiary_amount: '<string>',
    beneficiary_currency: '<string>'
  })
};

fetch('https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

{
  "statusCode": 400,
  "message": "sender is not ready"
}

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Sender not found"
}

{
  "statusCode": 422,
  "message": [
    "legal_name should not be empty",
    "country_code must be a valid ISO 3166-1 alpha-2 code"
  ]
}

{
  "statusCode": 429,
  "message": "Too many requests"
}

{
  "statusCode": 500,
  "message": "Internal server error"
}

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

Body

application/json

Only valid while the order is DRAFT. All fields optional — only sent fields are re-quoted.

beneficiary_profile_id

string<uuid>

beneficiary_amount

string

beneficiary_currency

string

fee_type

enum<string>

Available options:

OUR,

SHA

purpose_code

enum<string>

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

Response

Order re-quoted (single order object, not wrapped in a batch)

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

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

Organizations

Senders

Beneficiaries

Funding

Orders & Batches

Edit a draft order

Authorizations

Path Parameters

Body

Response