Get Payout Batches

This API will return all the payout batches of all the partner. We will pass date range to get the payout details and no of rows in response then we will get status: success/error, payout details of the batch in terms of code, name, created date, transaction type count.

GET

http://kraken.airpay.co.in:8000/payout/partner/payout-batches

Header

Field	Type	Description
Content-Type	String	application/json
Authorization	String	Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Header-Example:

{
    "Accept": "application/json",
    "Authorization": "Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Parameter

Field	Type	Required	Description
from_date	Date	No	Payout batch created from date in Y-m-d format
to_date	Date	No	Payout batch created to date in Y-m-d format
offset	Numeric	No	Row number from which records should start retrieving
limit	Numeric	Yes	Number of rows in the response (maximum length 25)

Request-Example

HTTP get

GET 'partner/payout-batches?offset=0&limit=25&from_date=2022-01-10&to_date=2022-01-25'

Success 200

Field	Type	Description
status	Alphanumeric	success / error
message	Alphanumeric	Response description
errors	Array	Error messages if response status is ‘error’
data	Array	Response data
data[code]	Alphanumeric	Payout batch code
data[name]	Alphanumeric	Batch name
data[created_datetime]	DateTime	Batch created date time (Y-m-d H:i:s)
data[transfers_count]	Numeric	Total number of transfers in the batch
data[pending_transfers_count]	Numeric	Number of transfers waiting for Airpay approval
data[approved_transfers_count]	Numeric	Number of transfers approved by Airpay
data[processing_transfers_count]	Numeric	Number of transfers in process
data[success_transfers_count]	Numeric	Number of successful transfers
data[failure_transfers_count]	Numeric	Number of failed transfers
data[rejected_transfers_count]	Numeric	Number transfers rejected by Airpay

Example Response Encrypted

{
    "status": "success",
    "message": "Payout batches",
    "data": "52IzcZ2t8X3Ruv3arybKEgPjO8Glpgz3ZdbIKxDHgE5Euo8GULIlMJe7pCvb8drXgvHE3D4asAPCHA44FU0C/oHvlL9Wxd7jheEgbD2cJmHITskTJhey5JE4Kd7UtysNR978yRBpyayfNPvwVEWuH39YmEWKdRLjjXIytM/anNAeFHq1Gg9v9gtRyJK3F0woHHlyU9ZpR+phVK+DD+3Lyq/4ZZ1ypWPLBil/k7n4ynfeuqC7/UtlN6aT5jKNkMNORSKeiPYPt9V5sOqUfoLno92hE9Ib0icYCrmVLkQeSme/7Al1iI/5PdpHuNv8LaQ70q8LOE7Fk5UsRSPazWMw3mHt+w5uXiPaEQSxS3jMM5oFfDsGw9ByPw2kpRGkEYZqgWSUXNCeDrresjQvXVUwgr5BohHDbzs5GAbqa8eCKMMaY295rf2ov8gSWIk6BeTTi3/viPUiPLyZsJWkcp8DNC8M4pFRhq41O6M4WCyARYkPZMNqFoALGKd2gxsQgV5tPNtxPEpIqHvDAHo8qm4Ro9Hr1s6q7CU96D0EhwurpSGFfSNDoe09hbMHEGnaPNsm3yuLA1kb494MFzrNhNA0mVG10fy2NALddVyhMa6fymIkIvIPzdYF3r2j8X5wkcH5fDdQikpMeMkCBfFn7R2859a3k72rlM5g/vuvJmE7xo/BU0UebIAW6CUfX1/fUB9cZifz7evMk2ZqCBWYqW0kWSy0sNq2Mn26VoR1g4YJfGvKWJBNHkxE0HO3cDNBp6P9e5gBY1j9pMG+vP+BLKWWaA=="
}

Response Decrypted

{
    "status": "success",
    "message": "Payout batches",
    "data": [
        {
            "code": "2022JANP1",
            "name": "Affiliate Payout January 2022- Batch 2",
            "created_datetime": "2022-02-12 20:48:14",
            "transfers_count": 2,
            "pending_transfers_count": "1",
            "approved_transfers_count": "1",
            "processing_transfers_count": "1",
            "success_transfers_count": "0",
            "failure_transfers_count": "0",
            "rejected_transfers_count": "1"
        },
        {
            "code": "2022JAN",
            "name": "Affiliate Payout January 2022",
            "created_datetime": "2022-02-07 05:46:12",
            "transfers_count": 2,
            "pending_transfers_count": "2",
            "approved_transfers_count": "0",
            "processing_transfers_count": "0",
            "success_transfers_count": "0",
            "failure_transfers_count": "0",
            "rejected_transfers_count": "0"
        }
    ]
}