RetrieveSettlement

v1.0.0

Provides comprehensive information for a single settlement.

The returned Settlement objects include an entries field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds.

Square initiates its regular deposits as indicated in the help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day.

Square does not know when an initiated settlement completes, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer.

Input

{
  "type": "object",
  "properties": {
    "location_id": {
      "type": "string"
    },
    "settlement_id": {
      "type": "string"
    }
  },
  "required": [
    "location_id",
    "settlement_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "V1Settlement",
  "properties": {
    "bank_account_id": {
      "type": "string",
      "description": "The Square-issued unique identifier for the bank account associated with the settlement."
    },
    "entries": {
      "type": "array",
      "description": "The entries included in this settlement.",
      "items": {
        "type": "object",
        "description": "V1SettlementEntry",
        "properties": {
          "amount_money": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "Amount in the lowest denominated value of this Currency. E.g. in USD\nthese are cents, in JPY they are Yen (which do not have a 'cent' concept)."
              },
              "currency_code": {
                "type": "string"
              }
            }
          },
          "fee_money": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "integer",
                "description": "Amount in the lowest denominated value of this Currency. E.g. in USD\nthese are cents, in JPY they are Yen (which do not have a 'cent' concept)."
              },
              "currency_code": {
                "type": "string"
              }
            }
          },
          "payment_id": {
            "type": "string",
            "description": "The settlement's unique identifier."
          },
          "type": {
            "type": "string",
            "description": "The settlement's current status."
          }
        }
      }
    },
    "id": {
      "type": "string",
      "description": "The settlement's unique identifier."
    },
    "initiated_at": {
      "type": "string",
      "description": "The time when the settlement was submitted for deposit or withdrawal, in ISO 8601 format."
    },
    "status": {
      "type": "string",
      "description": "The settlement's current status."
    },
    "total_money": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "integer",
          "description": "Amount in the lowest denominated value of this Currency. E.g. in USD\nthese are cents, in JPY they are Yen (which do not have a 'cent' concept)."
        },
        "currency_code": {
          "type": "string"
        }
      }
    }
  }
}