🧾Orders
API's to manage Orders.
Production URL: https://orders-v1-api-t3mipd377q-ey.a.run.app
Create Order
Your unique API Key.
Your API Hash.
Order type e.g. "payment", "deposit".
Name of the order.
Description of the order.
Unique order number.
Total amount of the order.
Email of the customer making the order.
URL to notify after order is completed.
URL to redirect to after order is completed.
POST /orders HTTP/1.1
Host:
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 339
{
"type": "text",
"name": "text",
"description": "text",
"orderNumber": "text",
"amount": 1,
"email": "text",
"notifyUrl": "text",
"returnUrl": "text",
"customerInformation": {
"firstName": "text",
"lastName": "text",
"dob": {
"year": 1,
"month": 1,
"day": 1
},
"address": {
"country": "text",
"line1": "text",
"line2": "text",
"city": "text",
"state": "text",
"postalCode": "text"
}
}
}{
"message": "text",
"data": {
"orderId": "text",
"paymentUrl": "text"
}
}Order Notify Url (Webhook)
WARNING: Ensure that your system accepts payments ONLY when the status of the notifyUrl request is "success".
Order Completed Notify Url
POST https://your-notify-url
Request Body
orderId*
string
NovaX Order Id.
orderNumber*
string
Unique Order Number .
status*
string
Status of the order upon completion:
success: Payment has been successfully processed.
expired: The order has expired.
cancelled: The order has been cancelled.
date*
string
Order complettion date. i.e
2024-01-07T19:05:30.175Z
amount
number
The paid amount. Amount will only be present if the status is equal to success.
txId
String
The payment NovaX txId. TxID will only be present if the status is equal to success.
Order Redirect Url
When an order receives a final outcome, the Payment Gateway will redirect to the specified redirect URL. The redirect URL will have the following parameters appended:
?orderId=[ORDER_ID]&orderNumber=[ORDER_NUMBER]&status=[STATUS]
i.e https://your-redirect-url?orderId=004Qs494RxpEMFYUyXBz&orderNumber=323421&status=success
ORDER_ID
The NovaX Order Id
ORDER_NUMBER
The orderNumber supplied in the creation of the order.
STATUS
Status of the order upon completion:
success: Payment has been successfully processed.
expired: The order has expired.
cancelled: The order has been cancelled.
Get Order
Id of the order to retrieve.
Your unique API Key.
Your API Hash.
GET /orders HTTP/1.1
Host:
x-api-key: text
x-api-hash: text
Accept: */*
{
"message": "text",
"data": {
"id": "text",
"orderNumber": "text",
"name": "text",
"description": "text",
"amount": 1,
"amountPaid": 1,
"amountDue": 1,
"status": "new",
"state": "pending",
"email": "text",
"notifyUrl": "text",
"returnUrl": "text",
"createdDate": "text",
"modifiedDate": "text"
}
}Cancel Order
Id of the order to cancel.
Your unique API Key.
Your API Hash.
PUT /orders/:orderId/cancel HTTP/1.1
Host:
x-api-key: text
x-api-hash: text
Accept: */*
{
"message": "text",
"data": {
"orderId": "text",
"status": "new"
}
}Refund Order to NovaX Account
Your unique API Key.
Your API Hash.
Name of the order.
Description of the order.
POST /orders/:orderId/refund HTTP/1.1
Host:
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"novaxUserId": "text",
"notifyUrl": "text"
}{
"message": "text"
}Refund Order to Crypto Address
The unique identifier of the order for which the refund is to be processed.
Your unique API Key.
Your API Hash.
POST /orders/:orderId/refund/crypto/otp HTTP/1.1
Host:
x-api-key: text
x-api-hash: text
Accept: */*
{
"message": "text"
}The unique identifier of the order for which the refund is to be processed.
Your unique API Key.
Your API Hash.
Crypto address to which the refund will be sent.
Blockchain network used for the refund. e.g. 'BSC', 'MATIC', 'TRON'.
Type of cryptocurrency token to be refunded. e.g. 'USDT'.
An identifier for the third-party service, if applicable.
One-time password for transaction verification.
URL to notify upon the final status of the refund process.
POST /orders/:orderId/refund/crypto HTTP/1.1
Host:
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"address": "text",
"network": "text",
"token": "text",
"thirdPartyId": "text",
"otp": "text",
"notifyUrl": "text"
}{
"message": "text"
}Refund NotifyUrl Request (Webhook)
POST https://your-refund-notify-url
Request Body
type*
string
order_refund | order_refund_crypto
orderId*
string
NovaX Order Id.
orderNumber*
string
Unique Order Number .
status*
string
Status of the order refund upon completion:
refunded: Order has been refunded successfully.
date*
string
Order complettion date. i.e
2024-01-07T19:05:30.175Z
amount*
number
The refunded amount.
txId*
string
The payment NovaX txId.
thirdPartyId
string
The specified thirdPartyId is used to initiate the refund request.
address
string
The address to which the refunded amount was sent. This address is provided when the type is order_refund_crypto.
token
string
The token, such as USDT, that has been transferred to the blockchain address.
network
string
The network used to transmit the token.
txHash
string
The blockchain transaction ID, which can be used to verify the legitimacy of the transfer.
Last updated