643 matches
60 actions
Square
60 actions
Finance/Square
Lists refunds for one of a business's locations.
In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications.
Refunds with a status of PENDING are not currently included in this
endpoint's response.
Max results per : 50
{
"type": "object",
"properties": {
"begin_time": {
"type": "string"
},
"cursor": {
"type": "string"
},
"end_time": {
"type": "string"
},
"location_id": {
"type": "string"
},
"sort_order": {
"type": "string"
}
},
"required": [
"location_id"
],
"additionalProperties": false
}{
"type": "object",
"description": "Defines the fields that are included in the response body of\na request to the [ListRefunds](https://developer.squareup.com/reference/square_2021-08-18/transactions-api/list-refunds) endpoint.\n\nOne of `errors` or `refunds` is present in a given response (never both).",
"properties": {
"cursor": {
"type": "string",
"description": "A pagination cursor for retrieving the next set of results,\nif any remain. Provide this value as the `cursor` parameter in a subsequent\nrequest to this endpoint.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information."
},
"errors": {
"type": "array",
"description": "Any errors that occurred during the request.",
"items": {
"type": "object",
"description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"description": "The high-level category for the error."
},
"code": {
"type": "string",
"description": "The specific code of the error."
},
"detail": {
"type": "string",
"description": "A human-readable description of the error for debugging purposes."
},
"field": {
"type": "string",
"description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
}
}
}
},
"refunds": {
"type": "array",
"description": "An array of refunds that match your query.",
"items": {
"type": "object",
"description": "Represents a refund processed for a Square transaction.",
"required": [
"id",
"location_id",
"transaction_id",
"tender_id",
"reason",
"amount_money",
"status"
],
"properties": {
"additional_recipients": {
"type": "array",
"description": "Additional recipients (other than the merchant) receiving a portion of this refund.\nFor example, fees assessed on a refund of a purchase by a third party integration.",
"items": {
"type": "object",
"description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.",
"required": [
"location_id",
"amount_money"
],
"properties": {
"amount_money": {
"type": "object",
"description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.",
"properties": {
"amount": {
"type": "integer",
"format": "int64",
"description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
},
"currency": {
"type": "string",
"description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values."
}
}
},
"description": {
"type": "string",
"description": "The description of the additional recipient."
},
"location_id": {
"type": "string",
"description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender."
},
"receivable_id": {
"type": "string",
"description": "The unique ID for this [AdditionalRecipientReceivable](https://developer.squareup.com/reference/square_2021-08-18/objects/AdditionalRecipientReceivable), assigned by the server."
}
}
}
},
"amount_money": {
"type": "object",
"description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.",
"properties": {
"amount": {
"type": "integer",
"format": "int64",
"description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
},
"currency": {
"type": "string",
"description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values."
}
}
},
"created_at": {
"type": "string",
"description": "The timestamp for when the refund was created, in RFC 3339 format."
},
"id": {
"type": "string",
"description": "The refund's unique ID."
},
"location_id": {
"type": "string",
"description": "The ID of the refund's associated location."
},
"processing_fee_money": {
"type": "object",
"description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.",
"properties": {
"amount": {
"type": "integer",
"format": "int64",
"description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
},
"currency": {
"type": "string",
"description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values."
}
}
},
"reason": {
"type": "string",
"description": "The reason for the refund being issued."
},
"status": {
"type": "string",
"description": "The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`,\nor `FAILED`)."
},
"tender_id": {
"type": "string",
"description": "The ID of the refunded tender."
},
"transaction_id": {
"type": "string",
"description": "The ID of the transaction that the refunded tender is part of."
}
}
}
}
}
}