1. Order
Artha All Module Api's
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Products
    • List Products
      GET
    • Get Product
      GET
    • Get Customer Product Status
      GET
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Submit Applicant (KYC/KYB)
      POST
    • Create Onboarding Session
      POST
  • Wallets
    • Beneficiary
      • Create Crypto Beneficiary
      • Update Crypto Beneficiary
      • List Crypto Withdraw Beneficiaries
    • Create Wallet
      POST
    • Get Wallet Address
      GET
    • Get Customer Balances
      GET
    • List Wallets
      GET
    • List Withdrawals
      GET
    • List Withdrawal Networks
      GET
    • Preview Withdrawal Summary
      POST
    • Create Crypto Withdrawal
      POST
  • Cards
    • Issuance
      • Issue Card
      • List Cards
      • List Customer Cards
      • Get Card Details
      • Get Sensitive Card Details
    • Funding
      • Top Up Card
      • Get Card Balance
      • Get Top-Up Status
      • List Top-Up History
    • Operations
      • Resend Activation Code
      • Activate Card
      • Set Card PIN
      • Change Card PIN
      • Update Card Limits
      • Freeze Card
      • Unfreeze Card
      • Replace Card
      • Cancel Card
      • Get Card Limits
      • Show Card PIN Details
      • Get PIN View Iframe URL
      • Get PIN Change Iframe URL
      • Get PIN Set Iframe URL
      • Get Card View Iframe URL
      • Show Card PIN
  • Payees
    • Create a payee for a customer.
    • List a customer's payees.
    • Update a payee.
    • Retrieve a payee by id.
    • Look up an existing payee.
    • List the currencies a payee can be created in.
    • List the accepted payment purpose codes for a payee.
    • List the countries a payee can be created in.
    • List currency/country pairings for payees.
    • List the accepted beneficiary relationship codes.
  • Payments
    • Onboarding
      • List the customer's payout-currency configuration sections.
      • Enable a payout-currency section for the customer.
      • Get the customer's terms-of-service acceptance status.
      • Enable or disable a payout-currency section.
    • Quote
      • List the currencies a beneficiary can be paid in under a product.
      • List the payout rails available for a product and beneficiary.
      • Create an FX quote giving the rate and fee for a cross-currency payout.
    • Order
      • Submit a payout order to send money to a beneficiary.
      • Retrieve the on-chain address to fund an order.
      • Retrieve the status and settlement detail of a payout order.
    • Lookups
      • List the accepted payment purpose codes for a payout.
      • List the accepted source-of-funds codes for a payout.
      • List the document types accepted on a payout order.
  • Banks
    • Accounts
      • Create Bank Account
      • Get Account Details
      • Get Account Issuance Status
    • Withdraw
      • Create Withdrawal Quote
      • List Withdrawal Purposes
      • Get Payment Schemes
      • Execute Withdrawal
  • Exchange
    • Quote
      • Get Exchange Rate
      • Create Price Quote
    • Order
      • Place Exchange Order
        POST
  • Transactions
    • List Transactions
    • Get Transaction Details
  • Utilities
    • List Currencies
    • List Countries
    • Get Fee Schedule
    • List Product Occupations
    • List Product Industry Codes
    • Upload File
  • Webhook's
    • Wallets Webhooks
    • Banks Webhooks
    • Payments Webhooks
    • Exchange Webhooks
    • Card Webhooks
  1. Order

Place Exchange Order

POST
/api/v1/order
Places a buy/sell exchange order for an existing customer.
Prerequisites
The customer must already exist and have an approved KYC status.
The customer must hold sufficient balance for the debited leg of the trade.
⚠️ Important
Order execution is asynchronous. A success response means the order was accepted — it starts in Pending and settles in the background.
Poll the Transactions API until the status becomes final before treating the trade as settled.
Unlike POST /api/v1/quote, the customerId moves into the body here.
Status values
StatusMeaning
PendingAccepted, executing in the background
CompletedSettled — balances updated
FailedRejected — insufficient balance, compliance, or market failure

⚠️ Required Fields
FieldTypeDescriptionConstraints
sidestringTrade direction from the customer's perspective: buy or sellRequired
customerIdstring (uuid)ID of the KYC-approved customer placing the orderRequired
cryptoobjectThe crypto leg of the tradeRequired
crypto.assetstringCrypto ticker (e.g. BTC, USDT)Required · 1-10 chars · ^[A-Za-z0-9]{1,10}$
crypto.amountnumberCrypto quantity to tradeRequired · Min: 0.00000001 · Max: 1e15
fiatobjectThe fiat leg of the tradeRequired
fiat.assetstringFiat code (e.g. USD, EUR)Required · 1-10 chars · ^[A-Za-z0-9]{1,10}$
Related endpoints: POST /api/v1/quote · List/Get Transactions

Request

Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
API Key
Add parameter in header
X-Timestamp
Example:
X-Timestamp: ********************
API Key
Add parameter in header
X-Nonce
Example:
X-Nonce: ********************
API Key
Add parameter in header
X-Body-Hash
Example:
X-Body-Hash: ********************
API Key
Add parameter in header
X-Signature
Example:
X-Signature: ********************
or
Body Params
application/json-patch+json

Examples

Responses

🟢202
application/json
Accepted — the order was accepted for asynchronous execution. It starts in Pending; poll the Transactions API for the final status.
Bodyapplication/json

🟠403
🟠409
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/order' \
--header 'X-API-Key: <api-key>' \
--header 'X-Timestamp: <api-key>' \
--header 'X-Nonce: <api-key>' \
--header 'X-Body-Hash: <api-key>' \
--header 'X-Signature: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data ''
Response Response Example
202 - Success
{
    "success": true,
    "message": null,
    "data": {
        "transactionId": "27188f34-53eb-45eb-8311-230b90f09646",
        "status": "Pending",
        "message": "Sell Transaction Saved Successfully"
    },
    "errors": []
}
Modified at 2026-09-16 12:52:10
Previous
Create Price Quote
Next
List Transactions
Built with