Orders
List orders
Introduction
About Koywe
- 🌳 What is Koywe
- ✨ Use Cases
Documentation
API Documentation
- 🛠 Overview
- Basic API flow
- Testing API Limitations
- GraphQL API
- RESTful API
- Overview
- Authentication
- Accounts
- Currency
- Token
- Payment Provider
- Payout Provider
- Quotes
- Orders
- Banks
- Deals
- Clients
Orders
List orders
To try these services, an Authorization token must be provided as a BearerToken header. The Authorization token can be obtained in the /auth service.
GET
/
orders
{
"data": [
{
"orderId": "b88f4ed0-10a2-412f-be3e-b5e47abe9b50",
"quoteId": "<string>",
"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",
"outReceipt": "98abd8a6dbdba6d4b",
"bankAccountId": "6294d815d2b5f912da43e699",
"metaData": "<string>",
"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"
}
}
}
],
"pagination": {
"totalcount": 30,
"pageSize": 6,
"pageNumber": 5
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
This value has a limit of 50, represents the number of responses per page.
Number of pages shown.
The initial date from which records are retrieved. Format: YYYY-MM-DD. Records from this date onwards will be included unless an 'endDate' is specified.
The end date until which records are retrieved. Format: YYYY-MM-DD. Only records up to this date will be included. If omitted, records up to the current date are returned.
Response
200 - application/json
{
"data": [
{
"orderId": "b88f4ed0-10a2-412f-be3e-b5e47abe9b50",
"quoteId": "<string>",
"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",
"outReceipt": "98abd8a6dbdba6d4b",
"bankAccountId": "6294d815d2b5f912da43e699",
"metaData": "<string>",
"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"
}
}
}
],
"pagination": {
"totalcount": 30,
"pageSize": 6,
"pageNumber": 5
}
}