View

View detailed payout information for a specific date

Payouts View Object

Fields	Description	Type	Filterable	Required	Readonly
processingDate	Date	Date	Yes	Yes	Yes
deposit	Deposit Amount	Number	No	No	Yes
fees	Fee Object	Object	No	No	Yes
fees.items	Fees Items Object	Object	No	No	Yes
fees.items.cardType	Fee Card Type	String	No	No	Yes
fees.items.amount	Fee Amount	Number	No	No	Yes
fees.totalAmount	Fees Total Amount	Number	No	No	Yes
chargebacks	Chargebacks Object	Object	No	No	Yes
chargebacks.items	Chargebacks Items Object	Object	No	No	Yes
chargebacks.items.referenceNumber	Chargeback Reference Number	String	No	No	Yes
chargebacks.items.amount	Chargeback Amount	Number	No	No	Yes
chargebacks.totalCount	Chargebacks Total Count	Integer	No	No	Yes
chargebacks.totalAmount	Chargebacks Amount	Number	No	No	Yes
reservedFunding	Reserved Funding Object	Object	No	No	Yes
reservedFunding.items	Reserved Funding Items Object	Object	No	No	Yes
reservedFunding.items.department	Reserve Department	String	No	No	Yes
reservedFunding.items.amount	Reserve Amount	Number	No	No	Yes
reservedFunding.totalAmount	Reserved Funding Amount	Number	No	No	Yes
releasedAmount	Released Amount	Number	No	No	Yes
batches	Batch Object	Object	No	No	Yes
batches.date	Batch Date	Date	No	No	Yes
batches.amount	Batch Amount	Number	No	No	Yes
batches.sequence	Batch ID / #	Integer	No	No	Yes

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200View

application/json

Body

Example

{
    "items": [
        {
            "processingDate": "2023-04-05",
            "deposit": 732.79,
            "fees": {
                "items": [
                    {
                        "cardType": "MASTERCARD",
                        "amount": "0.24"
                    },
                    {
                        "cardType": "MC DEBIT",
                        "amount": "17.34"
                    },
                    {
                        "cardType": "VISA",
                        "amount": "1.00"
                    },
                    {
                        "cardType": "VISA DEBIT",
                        "amount": "3.37"
                    }
                ],
                "totalAmount": 21.95
            },
            "chargebacks": {
                "items": [
                    {
                        "referenceNumber": "0000090001705578",
                        "amount": "-39.95"
                    }
                ],
                "totalCount": 1,
                "totalAmount": -39.95
            },
            "reservedFunding": {
                "items": [
                    {
                        "department": "RISK - AXIOM",
                        "amount": "83.86"
                    }
                ],
                "totalAmount": 83.86
            },
            "releasedAmount": 0,
            "batches": {
                "date": "2023-04-05",
                "amount": "1212.05",
                "sequence": "391"
            }
        }
    ],
    "_meta": {
        "totalCount": 1,
        "pageCount": 1,
        "currentPage": 1,
        "perPage": 30
    }
}

Request

Request Code Samples

Responses