AtaraPay Docs

AtaraPay Docs

  • Integration
  • API Reference

›Order Notification

Integration Overview

  • Get Started
  • Ground-up Development
  • Framework Development

Authentication

  • Calculation of Auth Token

Payment Plugin

  • Inline Integration
  • Standard Integration
  • Go Live

eCommerce Plugin

  • WooCommerce Payment Plugin
  • Magento Payment Extension
  • Shopify Payment Plugin

Payouts

  • Service Provider API
  • Create Service Provider
  • Get Service Provider
  • Delete Service Provider
  • Update Order Commission (Business Seller)
  • Update Order Commission (Marketplace Operator)

Milestone Payments

  • Overview
  • Create Project
  • Update Project
  • Get Project

Order Status Automation

  • Overview
  • Delivery Completed API.
  • Seller Cancels Order API
  • Buyer Cancels Order API
  • Order Status API

Order Notification

  • Overview
  • Delivery Complete Notification
  • Buyer Accepts Order Notification
  • Buyer Rejects Order Notification
  • Buyer Cancels Order Notification
  • Buyer Cancels Disputed Order Notification
  • Seller Cancels Order Notification
  • Seller Cancels Disputed Order Notification
  • Second Delivery Attempt Notification
  • Generation of Security Token

Resources

  • Status Definition
  • Get Bank Details
  • Marketplace Integration
  • Product Features List

Seller Cancels Order Notification

This notification is sent to the callback URL when the seller cancels the order from the AtaraPay dashboard.

Find below the request json params that are sent to the callback URL provided by the seller using the POST method.

Request json

{
    "status": "Canceled",
    "message": "Transaction is canceled",    
    "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,
        "refund":{
            "id":2152,
            "type":7,
            "beneficiary_id":131,
            "seller_id":0,
            "transaction_id":3430,
            "reference":"LNG-2be6b1620a7911eb845c00163e619ad2",
            "gateway_ref":null,
            "gateway_response":null,
            "amount":"5749305",
            "currency":"NGN",
            "status":"Completed",
            "created_at":"2020-10-09 21:52:06",
            "updated_at":"2020-10-09 21:52:06",
            "defination":{
                "name":"P2P_Ecommerce Reject Refund",
                "description":"Refund Logistic Fee on Reject to Buyer",
                "test":"",
                "comments":"",
                "date_created":"2019-09-25 09:40:25",
                "date_modified":"2019-09-25 10:17:20"
            }
        }
        "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 namevalue typeDescription
statusstringThis parameter defines the status of the order in AtaraPay.
messagestringThis parameter defines the user friendly description of the status of the order in AtaraPay.
dataObjectThis 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
tokenstringThis 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.
← Buyer Cancels Disputed Order NotificationSeller Cancels Disputed Order Notification →
Docs
IntegrationeCommerce PluginsAPI ReferenceAtaraPay
Other Links
About UsFrequently Asked QuestionsReport a Bug
Merchants
BenefitsOur Merchants
Follow @atarapayonline
AtaraPay
Copyright © 2024 AtaraPay