๐งพOrders
API's to manage Orders.
Production URL: https://orders-v1-api-rdqehkur6a-ey.a.run.app
Create Order
Please Note: If you want to pre-populate user data for the Stripe Onramp payment feature - Please ensure to add the customerInformation
object data.
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
Name | Type | Description |
---|---|---|
orderId* | string | TygaPay Order Id. |
orderNumber* | string | Unique Order Number . |
status* | string | Status of the order upon completion:
|
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 |
currency | string | i.e USDT, KRU etc
Currency will only be present if the status is equal to |
txId | String | The payment TygaPay txId. TxID will only be present if the status is equal to |
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
Fields | Description |
---|---|
ORDER_ID | The TygaPay Order Id |
ORDER_NUMBER | The orderNumber supplied in the creation of the order. |
STATUS | Status of the order upon completion:
|
Note: TygaPay will accommodate the specific format required for your redirect URL.
Get Order
Retrieves an order by Id.
Id of the order to retrieve.
Order successfully retrieved.
A message indicating the result of the operation.
Cancel Order
Cancels an order by Id.
Id of the order to cancel.
Order successfully canceled.
A message indicating the result of the operation.
Refund Order to TygaPay Account
Refunds an order by Id.
Name of the order.
Description of the order.
Order successfully refunded.
A message indicating the result of the operation.
Refund Order to Crypto Address
To process a refund to a cryptocurrency address, an OTP (One-Time Password) is necessary. Please reach out to support@tygapay.com to set up the Tenant Admin account that will receive these OTPs.
Send a refund OTP to the tenant admin's account.
The unique identifier of the order for which the refund is to be processed.
Order Refund OTP has been sent successfully.
A message indicating the result of the operation.
Process a cryptocurrency refund for an order.
The unique identifier of the order for which the refund is to be processed.
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.
Successfully initiated the refund request.
A message indicating the result of the operation.
Refund NotifyUrl Request (Webhook)
POST
https://your-refund-notify-url
Request Body
Name | Type | Description |
---|---|---|
type* | string |
|
orderId* | string | TygaPay Order Id. |
orderNumber* | string | Unique Order Number . |
status* | string | Status of the order refund upon completion:
|
date* | string | Order complettion date. i.e 2024-01-07T19:05:30.175Z |
amount* | number | The refunded amount. |
currency* | string | The refunded currency. i.e USDT |
txId* | string | The payment TygaPay txId. |
thirdPartyId | string | The specified |
address | string | The address to which the refunded amount was sent. This address is provided when the type is |
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