Get Refunds

Confirm payout of recovered delivery fees or funds for partial redemption


 

Definition

https://api.cashvaultng.com/stagmerce/GetMerchantRefunds?


Parameters

Query Params
merchantId:
required
string

Biller code for courier

startDate:
required
datetime

Search filter criterion

endDate:
required
datetime

Search filter criterion

Headers
ClientID:
required
string

Authentication Parameter

ClientSecretKey:
required
string

Authentication Parameter

Examples

HTTP

                            
                                https://api.cashvaultng.com/stagmerce/GetMerchantRefunds?merchantId=A00001&startDate=2017-09-01 04:14:49&endDate=2017-10-01 04:14:49
                            
                        

Result Format

200 Success 202 No Records

                                    
                                        {
                                            "ResponseCode": "00",
                                            "ResponseDescription": "OK",
                                            "MerchantRefunds":
                                            [
                                                {
                                                    "DisburseReference": "131950000000R2001001",
                                                    "RefundItem":
                                                    [
                                                        {
                                                            "Amount": 400,
                                                            "CbnCode": "039",
                                                            "Date": "25-09-2017 00:42:29",
                                                            "MerchantOrderNo": "ZOLO00700001",
                                                            "ReservationID": "A0000100000002",
                                                            "Status": "Success"
                                                        },
                                                        {
                                                            "Amount": 1400,
                                                            "CbnCode": "039",
                                                            "Date": "25-09-2017 00:42:29",
                                                            "MerchantOrderNo": "ZOLO00700016",
                                                            "ReservationID": "A0000100000007",
                                                            "Status": "Success"
                                                        }
                                                    ],
                                                    "TotalAmount": 1800,
                                                    "TransactionCount": 2
                                                }
                                            ]
                                        }
                                    
                                
                                    
                                        {
                                            "ResponseCode": "00",
                                            "ResponseDescription": "OK",
                                            "MerchantRefunds": []
                                        }