Dinar Dragon API Documentation

STEP 3: Use the /status POST endpoint to check the status of payments in your payout. It will return the completion status of payments in the payout. Pass the following data to the /status POST endpoint:

EXPECTED FIELDS TO OBTAIN PAYMENT STATUS:

You will also need to provide an Authorization value in the header of your HTTP request. You provide your private key here.

The data returned from this endpoint will be an array of objects accessible in the "payments" property of the response, where each object in the array contains information about the status one of your payments in the payout.

Here are examples of how to structure your HTTP body for this request:

                
                    //use this body when you only want the status of a single payment
                    {
                        "uniqueid": "df9a31ea528a3977" //unique ID for singular payment out of an entire payout
                    }
                
                

                
                    //use this body when you want the status of an entire payout with all its payments
                    {
                        "payment_id": "1617fcccd1f3269c" //unique ID for an entire payout
                    }
                
                

Here are the expected JSON responses:

SUCCESS:

HTTP RESPONSE:

CONTENTS OF EACH OBJECT IN PAYMENTS (ARRAY OF OBJECTS):

If your request failed, you will get this response:

FAIL:

If you are querying the status of only one payment from a payout, the "payments" array will return the status of just that payment as an array with only one status object.

                
                 {
                    "code": 200, //OK
                    "payments":
                    [
                        {
                            "uniqueid": "yourpaymentid", 
                            "status": 1 //payment successful
                        }
                    ]

                }
                
            

If you are querying the status of an entire payout, the "payments" array will return a list of objects that represent the status of every payment in the payout.

                
                 {
                    "code": 200,  //OK
                    "payments":
                    [
                        //Payment 1
                        {
                            "uniqueid": "firstpaymentid", 
                            "status": 0 //payment processing
                        },

                        //Payment 2
                        {
                            "uniqueid": "secondpaymentid", 
                            "status": 1 //payment successful
                        },

                        //Payment 3
                        {
                            "uniqueid": "thirdpaymentid", 
                            "status": 2 //payment failed
                        },

                        //......and so on

                   ]
                 }
                
            

If your request fails, you can expect a response in this format:

                
                    {
                        "code": 400, //Fail
                        "error": "Missing API key in request headers.",
                    }
                
            

Here are some code examples you can copy and paste: