API Reference

Transactions

View transactions for fulfilled orders

GET/v1/transactions/{orderId}

Get Transaction By Order ID

Get a transaction by order ID. Every order that has been paid has a transaction associated with it. This endpoint returns the transaction details for a given order ID.

Authorization

x-api-key
Required
<token>

The API key to authenticate requests provided by Roastify. If you do not have an API key, please contact [email protected]

In: header

Path Parameters

orderId
Required
string

The Id of the order

Example: "1ef87e47-266e-466f-ab06-a64994aefbb0"Minimum length: 1
Status codeDescription
200Get a transaction by order ID
400Returns an error
401Unauthorized
404Not Found
422Data Validation Error
500Internal Server Error
curl -X GET "https://api.roastify.app/v1/transactions/1ef87e47-266e-466f-ab06-a64994aefbb0"

{
  "createdAt": "2021-08-25T20:00:00.000Z",
  "orderId": "65df6d09eb81B03ab600782c",
  "amount": 1000,
  "currency": "USD",
  "paymentStatus": "paid",
  "paymentMethod": "card",
  "type": "balanceTransaction"
}

Previous

Stock

Next

Variants