Get a Payout

Developing

Cloud Mock

https://mock.apidog.com/m1/828215-0-default

GET

/payouts/{payout_reference}

OperationId:get_payout_by_reference

Get a paginated list of the payment requests fulfilled by this payout reference

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Token URL: https://{domain}.auth.{region}.amazoncognito.com

Scopes:

payouts:read-Can read payout reports

Path Params

Query Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://mock.apidog.com/m1/828215-0-default/payouts/?start_index=0&limit=50' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "payout_record": {
        "payout_reference": "xo7aV80R2m0WCoP",
        "total_amount": 392400,
        "payment_count": 225,
        "created_date": "2025-07-28T15:18:54.437Z",
        "currency": "GYD",
        "payments": {
            "results": [
                {
                    "payment_request_id": "46c1b8a4-7cdc-45f6-8d24-2487a94a2fda",
                    "amount": 22330
                },
                {
                    "payment_request_id": "28d0affa-90d2-4cc7-aeaf-d0267a41e9fa",
                    "amount": 7510
                },
                {
                    "payment_request_id": "a43af14e-48a8-47e1-9fb4-56f4cde989c6",
                    "amount": 5686
                }
            ],
            "paging": {
                "start_index": 34,
                "count": 225,
                "previous_page": "https://dTrBrKm.lnaad5F+2N5PEn4o9QkqbPmD",
                "next_page": "http://oVKmpwIUVIQSGGPlcEQRgGVGwm.nlnTLRbVmcbwendyOaya3dnkD5na9-"
            }
        }
    }
}

Payouts

Get Available Payouts