GET
/
v1
/
transactions
/
{orderId}
Get Transaction By Order ID
curl --request GET \
  --url https://api.roastify.app/v1/transactions/{orderId} \
  --header 'x-api-key: <api-key>'
{
  "createdAt": "2021-08-25T20:00:00.000Z",
  "orderId": "65df6d09eb81B03ab600782c",
  "amount": 1000,
  "currency": "USD",
  "paymentStatus": "paid",
  "paymentMethod": "card",
  "type": "balanceTransaction"
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.

Path Parameters

​
orderId
string
required

The Id of the order

Minimum length: 1
Example:

"1ef87e47-266e-466f-ab06-a64994aefbb0"

Response

Get a transaction by order ID

​
createdAt
string
required

The date the transaction was created

Example:

"2021-08-25T20:00:00.000Z"

​
orderId
string
required

The order ID associated with the transaction

Example:

"65df6d09eb81B03ab600782c"

​
amount
number
required

The amount of the transaction in cents. Ex: 1000 = $10.00

Example:

1000

​
currency
string
required

The currency of the transaction

Example:

"USD"

​
paymentStatus
string | null
required

The payment status of the transaction

Example:

"paid"

​
paymentMethod
string | null
required

The payment method used for the transaction

Example:

"card"

​
type
enum<string>
required

Enum for the type of transaction, either balanceTransaction or paymentIntent. BalanceTransaction is used for adjusting the customer's balance. PaymentIntent is used for processing payments using the customer's default payment method.

Available options:
balanceTransaction,
paymentIntent,
subscription
Example:

"balanceTransaction"