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.
        POST
      • Retrieve the on-chain address to fund an order.
        GET
      • Retrieve the status and settlement detail of a payout order.
        GET
    • 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
  • 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

Retrieve the status and settlement detail of a payout order.

GET
/api/v1/payments/order/{orderId}
Returns the amounts on both sides of the conversion, the rate and fee applied, the
provider reference and the estimated settlement time. Returns 404 ORDER_NOT_FOUND when
the order does not belong to the customer.
Prerequisites: the order must already exist and belong to the requesting customer.
Async vs sync: synchronous read reflecting the order's current lifecycle stage.
Related: created via POST /api/v1/payments/order; funded via GET .../getdepositaddress/{orderId}.

📤 Response Fields#

200 response:
FieldTypeNullableDescription
dataobjectNoThe on-chain address an order is funded through, as configured on the product's Metadata. network is returned alongside the address deliberately: an address is only valid on its own chain, so a caller must never be handed one without it.
data.transactionIdstring (uuid)NoOur internal id for this order — the same value passed as {orderId} in the path.
data.payoutIdstringYesThe provider-side identifier for this payout, when the provider has assigned one.
data.providerCodestringYesWhich provider is executing this payout, e.g. MESTA, TAZAPAY, NOAH.
data.statusstringYesOrder lifecycle status. See the status table above.
data.sourceCurrencystringYesCurrency the order was funded in (the debit side).
data.destinationCurrencystringYesCurrency the beneficiary is paid in (the credit side).
data.sourceAmountnumber (double)YesAmount debited, in sourceCurrency.
data.destinationAmountnumber (double)YesAmount credited to the beneficiary, in destinationCurrency.
data.exchangeRatenumber (double)YesRate applied between source and destination currency for this order.
data.feenumber (double)YesFee charged for the transfer, in feeCurrency.
data.feeCurrencystringYesCurrency the fee amount is denominated in.
data.referencestringYesThe provider's own reference for this payout, useful when reconciling with provider statements.
data.estimatedSettlementTimestring (date-time)YesWhen the payout is expected to land with the beneficiary.
data.createdAtstring (date-time)YesWhen the order was created.
data.updatedAtstring (date-time)YesWhen the order status was last updated.
requestIdstringYes—
timestampstring (date-time)No—

Request

Path Params

Query Params

Header Params

Responses

🟢200
application/json
OK
Bodyapplication/json

🟠401
🟠403
🟠404
🟠422
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/payments/order/7a2e4c9b-1f6d-4a3e-8c7b-9d0f2a5e6b18?customerId=c1f4a9d2-6b3e-4a7c-9f1d-2e8b5c0a7d31' \
--header 'X-API-Key: ak_live_8f3a9b2c7e1d4f6a9b0c2d5e8f1a3b6c' \
--header 'X-Signature: kZ3fQeT2m7xVvC9pR1sLdY8bN0hU4jK6oW5aE2gI7cQ=' \
--header 'X-Timestamp: 1758556800' \
--header 'X-Nonce: 3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'X-Body-Hash: 47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU='
Response Response Example
200 - Success
{
    "data": {
        "transactionId": "7a2e4c9b-1f6d-4a3e-8c7b-9d0f2a5e6b18",
        "payoutId": "po_7f3a9c2e1b8d4f6a",
        "providerCode": "MESTA",
        "status": "processing",
        "sourceCurrency": "USDT",
        "destinationCurrency": "EUR",
        "sourceAmount": 5000,
        "destinationAmount": 4587.32,
        "exchangeRate": 0.917464,
        "fee": 12.5,
        "feeCurrency": "USDT",
        "reference": "MESTA-REF-88213F",
        "estimatedSettlementTime": "2026-09-23T10:00:00Z",
        "createdAt": "2026-09-22T14:02:47Z",
        "updatedAt": "2026-09-22T14:05:10Z"
    },
    "requestId": "req_4f9a2c7e1b8d3f6a9c2e0b7d1f8a3c6e",
    "timestamp": "2026-09-22T14:03:11Z"
}
Modified at 2026-09-22 10:35:55
Previous
Retrieve the on-chain address to fund an order.
Next
List the accepted payment purpose codes for a payout.
Built with