Refresh an order

Re-checks one order. Use it if the order looks stuck. Returns the single order. No request body.

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

Refresh an order

cURL

curl --request POST \
  --url https://api.mansa.xyz/api/v2/payouts/{batchId}/orders/{orderId}/refresh \
  --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": "006-26",
  "beneficiary_amount": "<string>",
  "beneficiary_currency": "USD",
  "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>",
  "fee_currency": "USD",
  "uetr": "<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 order with its latest status

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 · string · required

A code from Get purpose codes for this Sender and Beneficiary (for example 006-26). Do not hard-code it. OTHR ("other") is not supported yet.

Example:

"006-26"

beneficiary_amount · string · required

beneficiary_currency · enum<string> · required

Every order in a batch must use the same currency.

Available options: USD, EUR, CNH, AUD, CAD, HKD, JPY, NZD, SGD, GBP, AED

source_currency · string · required

Always "USDT" today

Example:

"USDT"

status · enum<string> · required

DRAFT: quoted, not confirmed; can be edited or cancelled · AWAITING_DEPOSIT: confirmed, USDT is moving out of your payout vault · DEPOSIT_RECEIVED: USDT received · PAYING_BENEFICIARY: the bank transfer is in progress · COMPLETED: paid · FAILED: not completed · CANCELLED_EXPIRED: cancelled by you, or the deposit never landed.

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 for the chosen fee_type. Always in USD.

source_amount · string | null

The total USDT the order costs, all fees included. This is the figure to size funding against.

failure_message · string | null

Present only when status is FAILED. Generic; Mansa follows up directly.

expires_at · string<date-time> | null

Set once the order reaches AWAITING_DEPOSIT. An order whose deposit hasn't landed within 2 hours of confirmation expires to CANCELLED_EXPIRED.

client_reference · string | null

fee_currency · string | null

Always USD.

Example:

"USD"

uetr · string | null

SWIFT UETR once the bank network reports one. May stay null after COMPLETED.