Delivery completed Notification
This notification is sent to the callback URL when AtaraPay marks the order as delivered.
Find below the request json params that are sent to the callback URL provided by the seller using the POST
method.
Request json
{
"status": "Delivered",
"message": "Order is marked completed",
"data": {
"id": 3029,
"type": 1,
"customer_id": 278,
"beneficiary_merchant_id": 117,
"seller_email": null,
"seller_phone": null,
"buyer_email": null,
"buyer_phone": null,
"buyer_alt_phone": null,
"buyer_account_number": null,
"buyer_bank_code": null,
"shipping_fee_bearer": null,
"escrow_fee_bearer": null,
"tx_fee_bearer": null,
"is_marketplace": 0,
"shipping_cost": 0,
"category": null,
"product_id": "1447",
"product_name": "Himanshu",
"product_desc": "Himanshu",
"product_cost": 400000,
"started_by": null,
"amount_payed": 450000,
"amount_net": 383250,
"payment_number": 2532,
"payment_ref": null,
"gateway_name": "Paystack",
"callback_url": null,
"comment": "Testing api cancelling",
"delivery_man": 0,
"delivery_location": "Gombe, NG, 140301",
"delivery_city": "",
"delivery_state": "",
"delivery_country": "",
"product_delivery_status": 0,
"transaction_date": "2020-06-27 07:30:54",
"delivery_date": "0000-00-00",
"status": {
"id": 9,
"title": "Canceled",
"description": "Order or Person to Person Transaction was Canceled",
"deleted_at": null,
"created_at": null,
"updated_at": null
},
"state": 0,
"shipping_method": null,
"quantity": null,
"max_delivery_days": 7,
"extra": null,
"is_additional_services": null,
"additional_service_amount": null,
"sla": 1,
"cancellation_fee": 20000,
"currency": "NGN",
"conversion_ratio": 1,
"deleted_at": null,
"created_at": "2020-06-27 07:30:54",
"updated_at": "2020-06-27 08:20:14",
"attempts": null,
"seller_attempts": "",
"cron_status": null,
"sp_order_ref": 0,
"payment": {
"id": 2532,
"payment_ref": "LNG-17a2cc64b84811eab96200163e619ad2",
"amount": 450000,
"method": "card",
"status": "1",
"payment_date": "2020-06-27 07:30:54",
"gateway_response": "Successful",
"narrative": null,
"deleted_at": null,
"created_at": "2020-06-27 07:30:54",
"updated_at": "2020-06-27 07:30:54"
},
"additional_services": [],
"customers": {
"id": 278,
"firstname": "Emeka",
"lastname": "Adeniyi",
"phone_number": "+2348082094382",
"phone_number_alt": null,
"email": "emeka.adeniyi@atarapay.com",
"otp_date": "2019-11-14 06:32:30",
"status": 1,
"deleted_at": null,
"created_at": "2019-08-28 12:17:37",
"updated_at": "2020-01-22 21:23:05"
},
"delivery_men": null
},
"token":"YjhrUDdBMWU2N3MwamMz6aDk4VDhwSDcxZHFQeUowcz7rM6UEtwNnozalRjTGVRTmMxaDN1OWUwZmZYOU5ZOTFhZEUxtdMg"
}
Defination of params
Param name | value type | Description |
---|---|---|
status | string | This parameter defines the status of the order in AtaraPay. |
message | string | This parameter defines the user friendly description of the status of the order in AtaraPay. |
data | Object | This Parameter returns the json object of the Order with the details of the Order, which include Order data ,Status data , Additional Services data , Payment data ,Customer data |
token | string | This Parameter is sent for security purposes. The seller's website needs to create the security token for the request as defined in the Security token generated steps and then validate that the token sent within the request is equal to that which was generated. Where the tokens don't match during validation, then the request shall not be processed. |