Getting Transaction History
a. Return the list of all transactions initiated via the Partner interface by a specific customer within the specified time
- If
currencyCodeis blank return transactions for all customer assets ordered by the most recent date/time - If the date range is blank, return the most recent 90 days of history
Sample API Request: GET
URL: https://caas-staging.coinme.com/services/transactionhistory?customerId=654987321¤cyCode=DOGE&startDateTime=2022-01-24T16:44:49Z&endDateTime=2022-01-25T16:44:49Z&page=0&size=90
headers:
"Authorization":"asdfghj", //authorization token,required,
'User-Agent: partnerapi' //required
Sample API Response:
Successful Response:
{
"data":
{
"transactions": [
{
"totalFees": "2.5",
"feeCurrencyCode":"USD",
"creditCurrencyAmount":"771.9075",
"creditCurrencyCode":"DOGE",
"debitCurrencyAmount":"100", //Amount value requested by User
"debitCurrencyCode":"USD",
"transactionDateTime": "2022-01-25T09:27:07.066193Z",//UTC
"partnerTransactionId": "345678",
"transactionStatus": "CONFIRMED",
"fromWalletAddress": "", //will be used in future for SEND and RECEIVE
"toWalletAddress": "", //will be used in future for SEND and RECEIVE
"promoCode":"noFees" //optional, if a promo code is used
},
{
"totalFees": "2.5",
"feeCurrencyCode":"USD",
"creditCurrencyAmount":"100", //Amount value requested by User
"creditCurrencyCode":"USD",
"debitCurrencyAmount":"749.0925",
"debitCurrencyCode":"DOGE",
"transactionDateTime": "2022-01-25T09:56:46.436559Z",//UTC
"partnerTransactionId": "345987",
"transactionStatus": "CONFIRMED",
"fromWalletAddress": "", //will be used in future for SEND and RECEIVE
"toWalletAddress": "", //will be used in future for SEND and RECEIVE
"promoCode":"noFees" //optional, if a promo code is used
},
{
"totalFees": "2.5",
"feeCurrencyCode":"USD",
"creditCurrencyAmount":"100", //Amount value requested by User
"creditCurrencyCode":"USD",
"providerTransactionRef:"12345678",
"debitCurrencyAmount":"749.0925",
"debitCurrencyCode":"DOGE",
"transactionDateTime": "2022-01-25T09:56:46.436559Z", //UTC
"partnerTransactionId": "345987",
"transactionStatus": "CONFIRMED",
"fromWalletAddress": "", //will be used in future for SEND and RECEIVE
"toWalletAddress": "", //will be used in future for SEND and RECEIVE
"promoCode":"noFees" //optional, if a promo code is used
}
]
},
"errorResponse": null
}
Failure Response:
{
"data": null,
"errorResponse": {
"httpStatus":"200",
"timestamp":"2022-02-01T18:59:28.297Z",//UTC
"path":"/services/transactionhistory GET",
"errorData": [
{
"errorCode":"123-123-123-123", //The error code is just a sample showing the structure of the error code.
"message":"Customer Id not found"
}
]
}
}
Error Codes
Error Code | Error Message |
|---|---|
193-500-352-000 | Internal error occurred, please try again or contact support |
193-400-352-912 | Page number must be greater than or equal to 0 Page size must be greater than 0 Page size cannot be greater than <pagination_max_size> |
b. The below API takes the partnerTransactionId in the request and returns the transactions related to only that particular transactionId.
Sample API Request: GET
URL: https://caas-staging.coinme.com/services/transactions?partnerTransactionId=345678
headers:
"Authorization":"asdfghj", //authorization token, required
'User-Agent: partnerapi' //required
Sample API Response:
Successful Response:
{
"data": {
"totalFees": "2.5",
"feeCurrencyCode": "USD",
"creditCurrencyAmount": "771.9075",
"creditCurrencyCode": "DOGE",
"debitCurrencyAmount": "100", // Amount value requested by User
"debitCurrencyCode": "USD",
"transactionDateTime": "2022-01-25T09:27:07.066193Z", // UTC
"partnerTransactionId": "345678",
"providerTransactionRef": "12345678",
"transactionStatus": "CONFIRMED",
"fromWalletAddress": "", // will be used in future for SEND and RECEIVE
"toWalletAddress": "" // will be used in future for SEND and RECEIVE
},
"errorResponse": null
}
Failure Response:
{
"data": null,
"errorResponse": {
"httpStatus": "200",
"timestamp": "2022-02-01T18:59:28.297Z", // UTC
"path": "/services/transactions GET",
"errorData": [
{
"errorCode": "123-123-123-123", // The error code is just a sample showing the structure of the error code.
"message": "Partner Transaction id not found"
}
]
}
}
Error Codes
| Error Code | Error Message |
|---|---|
| 180-500-352-000 | Internal error occurred, please try again or contact support |
| 180-404-352-904 | Transaction with the partnerTransactionId <partner_transaction_id> not found |
Updated about 12 hours ago
What’s Next