get-payout-response.md

Get Payout Response

Structure

GetPayoutResponse

Fields

Name	Type	Tags	Description	Getter	Setter
payout	?Payout	Optional	An accounting of the amount owed the seller and record of the actual transfer to their external bank account or to the Square balance.	getPayout(): ?Payout	setPayout(?Payout payout): void
errors	?(Error[])	Optional	Information about errors encountered during the request.	getErrors(): ?array	setErrors(?array errors): void

Example (as JSON)

{
  "payout": {
    "amount_money": {
      "amount": -103,
      "currency_code": "USD",
      "currency": "TZS"
    },
    "arrival_date": "2022-03-24",
    "created_at": "2022-03-24T03:07:09Z",
    "destination": {
      "id": "bact:ZPp3oedR3AeEUNd3z7",
      "type": "BANK_ACCOUNT"
    },
    "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45",
    "location_id": "L88917AVBK2S5",
    "status": "PAID",
    "type": "BATCH",
    "updated_at": "2022-03-24T03:07:09Z",
    "version": 1
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    },
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}