Get Payouts

Confirm status of settlement or deposit to accounts of sharing parties for redeemed reservations


 

Definition

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


Parameters

Query Params
merchantId:
required
string

Biller code of 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

Get Payouts

                            
                                https://api.cashvaultng.com/stagmerce/GetMerchantPayout?merchantId=A00476&startDate=2016-06-01 00:00:00&endDate=2016-06-30 23:00:00
                            
                        

Result Format

200 Success 202 No Record

                                    
                                        {
                                            "ResponseCode": "00",
                                            "ResponseDescription": "OK",
                                            "DisbursementPayouts":
                                            [
                                                {
                                                "DisburseReference": "131960000060",
                                                "DisbursementItems":
                                                    [
                                                        {
                                                            "Amount": 30000.00,
                                                            "CBNCode": "044",
                                                            "Date": "30-06-2016 09:01:42",
                                                            "MerchantOrderNo": "0",
                                                            "ReservationID": "A00476R107",
                                                            "Status": "Success"
                                                        }
                                                    ],
                                                    "TotalAmount": 30000.00,
                                                    "TransactionCount": 1
                                                },
                                                {
                                                    "DisburseReference": "131960000061",
                                                    "DisbursementItems":
                                                    [
                                                        {
                                                            "Amount": 30000.00,
                                                            "CBNCode": "044",
                                                            "Date": "30-06-2016 09:03:24",
                                                            "MerchantOrderNo": "0",
                                                            "ReservationID": "A00476R250",
                                                            "Status": "Success"
                                                        }
                                                    ],
                                                        "TotalAmount": 30000.00,
                                                        "TransactionCount": 1
                                                }
                                            ]
                                        }
                                    
                                
                                    
                                        {
                                            "ResponseCode": "00",
                                            "ResponseDescription": "OK",
                                            "DisbursementPayouts": []
                                        }