๐ŸงพOrders

API's to manage Orders.

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".

TygaPay will process the Notify Url once an Order has been completed.

POST https://your-notify-url

Request Body

NameTypeDescription

orderId*

string

TygaPay 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 TygaPay 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

FieldsDescription

ORDER_ID

The TygaPay 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.

Note: TygaPay will accommodate the specific format required for your redirect URL.

Get Order

Cancel Order

Refund Order

Last updated