POS Charge Actions
Refund Charge [EXPERIMENTAL]
Notice: This endpoint has different server URLs and authorization method than the rest of the API.
Refunds a POS charge.
post/pos/charges/{chargeKey}/refund
Request
- Base URLhttps://devices.eu-west-1.api.silverflow.com/v1
- AuthAPI key in header -
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
chargeKeystring required
Uniquely identifies a charge.
Example:chg-1e1dAHhgstYTUhlphPzZ
Uniquely identifies a charge.
Headers
Idempotency-Keystring
This key is used to deduplicate requests that are retried. For more information see the section on Idempotency.
Example:28gKCluIEKp8jVboUyr2
Request body
Example request
{
"reference": "cancel-001",
"dynamicDescriptor": {
"merchantName": "Acme Inc.",
"merchantCity": "Amsterdam"
}
}Response
Refund action created (either reversal or refund)
Example response
{
"key": "rvsl-5BH5chO93SXky5gw",
"chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
"reference": "cancel-001",
"replacementAmount": {
"value": 2599,
"currency": "EUR",
"breakdown": {
"baseAmount": 2599,
"cashback": 2599,
"gratuity": 2599
}
},
"authorizationResponse": {
"responseCode": "00",
"responseCodeDescription": "Approved"
},
"version": 1
}Changes
No recorded changes to this operation across all 1 revision of this API.