Returns order information by ExternalId.

curl https://api-sandbox.koywe.com/rest/orders/external_id/externalId \
     -H "Authorization: Bearer <token>"

{
  "orderId": "b88f4ed0-10a2-412f-be3e-b5e47abe9b50",
  "quoteId": "quoteId",
  "orderType": "currency-crypto",
  "symbolIn": "CLP",
  "symbolOut": "MATIC",
  "amountIn": 25000,
  "amountOut": 32.171150520770496,
  "email": "example@gmail.com",
  "exchangeRate": 746.01,
  "koyweFee": 1000,
  "partnerFee": 500,
  "networkFee": 1000,
  "status": "REJECTED",
  "statusDetails": "statusDetails",
  "outReceipt": "98abd8a6dbdba6d4b",
  "bankAccountId": "6294d815d2b5f912da43e699",
  "txHash": "txHash",
  "metaData": "metaData",
  "externalId": "A1d2t3456",
  "feesInFiat": {
    "koyweFee": 10,
    "netFee": 1,
    "partnerFee": 0.5
  },
  "feesInUSD": {
    "koyweFee": 10,
    "netFee": 1,
    "partnerFee": 0.5
  },
  "dates": {
    "confirmationDate": "2023-01-01T10:00:00Z",
    "paymentDate": "2023-01-01T12:00:00Z",
    "executionDate": "2023-01-01T14:00:00Z",
    "deliveryDate": "2023-01-01T16:00:00Z"
  },
  "destinationAddress": "0x40f9bf922c23c43acede50Ab4425280C0ffBD697",
  "paymentMethodId": "6294d815d2b5f912da43e699",
  "logoIn": "urlExample.com/currencies/CLP.svg",
  "logoOut": "urlExample.com/currencies/MATIC.svg",
  "refund": {
    "dates": {
      "startDate": "2023-01-01T18:00:00Z",
      "processDate": "2023-01-01T20:00:00Z",
      "deliveredDate": "2023-01-01T22:00:00Z"
    },
    "destinationAddress": "0x40f9bf922c23c43acede50Ab4425280C0ffBD697",
    "transactionReceipt": "98abd8a6dbdba6d4b"
  },
  "errors": {
    "invalidWithdrawalsDetails": {
      "_id": "6234f5d4d9f4",
      "name": "John Doe",
      "bankCode": "001",
      "countryCode": "CL",
      "currencySymbol": "CLP",
      "accountNumber": "1234567890",
      "account": "Savings",
      "accountType": "Savings",
      "entityName": "Banco de Chile"
    }
  },
  "bankAccount": {
    "id": "id",
    "accountNumber": "accountNumber",
    "accountType": "accountType",
    "bankName": "bankName"
  }
}

To try these services, an Authorization token must be provided as a BearerToken header. The Authorization token can be obtained in the /auth service.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

externalIdstringRequired

External Order's identifier.

Response

successful operation

orderIdstring

quoteIdstring

orderTypestring

symbolInstring

symbolOutstring

amountIndouble

amountOutdouble

emailstring

exchangeRatedouble

koyweFeedouble

partnerFeedouble

networkFeedouble

statusstring

statusDetailsstring

Additional details about the order status for off-ramp transactions

outReceiptstring

bankAccountIdstring

txHashstring

Transaction hash for transactions, either for outgoing or incoming transactions

metaDatastring

externalIdstring

feesInFiatobject

feesInUSDobject

datesobject

destinationAddressstring

paymentMethodIdstring

logoInstring

logoOutstring

refundobject

errorsobject

bankAccountobject

Bank account details associated with the order

Errors

404

Getorderby External ID Request Not Found Error