v11

latestOpenAPI 3.1.12026-08-03174162.0 MB

Payouts

List Airwallex payout adjustments

Returns settlement-proven Airwallex refund and dispute adjustments grouped for tenant payout review.

get/payouts/adjustments

Query parameters

teamIdstring required

querystring

status'OUTSTANDING' | 'APPLIED' | 'ALL'

groupBy'event' | 'payout'

eventIdstring

currency'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL'

Three-letter ISO 4217 currency code for transactions and payouts

Example:AUD

limitinteger

Maximum number of adjustments to return per request (1-100, default: 20)

Example:20

cursorstring

Opaque cursor for pagination. Use the cursor from the previous response to continue fetching results.

Response

summaryScope'PAGE' required

beforestring nullable

afterstring nullable

limitinteger required

Example response

{
  "adjustments": [
    {
      "currency": "AUD",
      "customer": {
        "id": "cus_01jps5cgsf4pn2a32eamppnap1",
        "firstName": "Test",
        "lastName": "User",
        "email": "test@session.services",
        "phone": "+61411111111"
      },
      "sourcePayout": {
        "price": {
          "net": 1000,
          "total": 1000,
          "gross": 1000,
          "base": 1000,
          "currency": "AUD"
        }
      },
      "applications": [
        {
          "currency": "AUD",
          "payout": {
            "price": {
              "net": 1000,
              "total": 1000,
              "gross": 1000,
              "base": 1000,
              "currency": "AUD"
            }
          }
        }
      ]
    }
  ],
  "eventGroups": [
    {
      "adjustments": [
        {
          "currency": "AUD",
          "customer": {
            "id": "cus_01jps5cgsf4pn2a32eamppnap1",
            "firstName": "Test",
            "lastName": "User",
            "email": "test@session.services",
            "phone": "+61411111111"
          },
          "sourcePayout": {
            "price": {
              "net": 1000,
              "total": 1000,
              "gross": 1000,
              "base": 1000,
              "currency": "AUD"
            }
          },
          "applications": [
            {
              "currency": "AUD",
              "payout": {
                "price": {
                  "net": 1000,
                  "total": 1000,
                  "gross": 1000,
                  "base": 1000,
                  "currency": "AUD"
                }
              }
            }
          ]
        }
      ],
      "totals": [
        {
          "currency": "AUD"
        }
      ]
    }
  ],
  "payoutGroups": [
    {
      "payout": {
        "price": {
          "net": 1000,
          "total": 1000,
          "gross": 1000,
          "base": 1000,
          "currency": "AUD"
        }
      },
      "adjustments": [
        {
          "currency": "AUD",
          "customer": {
            "id": "cus_01jps5cgsf4pn2a32eamppnap1",
            "firstName": "Test",
            "lastName": "User",
            "email": "test@session.services",
            "phone": "+61411111111"
          },
          "sourcePayout": {
            "price": {
              "net": 1000,
              "total": 1000,
              "gross": 1000,
              "base": 1000,
              "currency": "AUD"
            }
          },
          "applications": [
            {
              "currency": "AUD",
              "payout": {
                "price": {
                  "net": 1000,
                  "total": 1000,
                  "gross": 1000,
                  "base": 1000,
                  "currency": "AUD"
                }
              }
            }
          ]
        }
      ],
      "projections": [
        {
          "currency": "AUD"
        }
      ],
      "totals": [
        {
          "currency": "AUD"
        }
      ]
    }
  ],
  "summary": {
    "totals": [
      {
        "currency": "AUD"
      }
    ]
  }
}