v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Payouts

Get payout adjustment by ID

Returns a payout adjustment detail payload with related adjustment rows, applications, and upcoming payout projections.

get/payouts/adjustments/{id}

Path parameters

idstring required

Response

OK

Example response

{
  "adjustment": {
    "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"
          }
        }
      }
    ]
  },
  "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"
      }
    ]
  }
}