---
updatedAt: 2026-07-22T19:24:49.000Z
agentTools:
projectIndex: https://docs.staxpayments.com/llms.txt
---
# Refund
Performs a card-present refund for a prior sale by re-presenting the card at the terminal.
**(Advanced)** For processing refunds, we highly recommend using void-or-refund. Only use this route if you are CERTAIN the transaction has already batched.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "stax-api",
"version": "0.1"
},
"servers": [
{
"url": "https://apiprod.fattlabs.com/"
}
],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality."
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"paths": {
"/terminal/refund": {
"post": {
"summary": "Refund",
"description": "Performs a card-present refund for a prior sale by re-presenting the card at the terminal.",
"operationId": "refund",
"parameters": [],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"id\": \"4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7\",\n \"invoice_id\": \"\",\n \"reference_id\": \"5114aea7-5c7f-40ab-8a62-84f239e4b2b1\",\n \"recurring_transaction_id\": \"\",\n \"auth_id\": null,\n \"type\": \"refund\",\n \"source\": \"terminalservice.dejavoo\",\n \"is_merchant_present\": true,\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"payment_method_id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"is_manual\": true,\n \"success\": true,\n \"message\": \"\",\n \"meta\": {\n \"lineItems\": [\n {\n \"item\": \"\",\n \"details\": \"\",\n \"quantity\": 1,\n \"price\": \"0.01\"\n }\n ],\n \"subtotal\": 0.01,\n \"tax\": 0,\n \"taxRate\": 10,\n \"isBulkInvoice\": false,\n \"taxOverride\": false,\n \"update_inventory\": true,\n \"reference\": 2477,\n \"RegisterId\": 3594291,\n \"ResultCode\": 0,\n \"RespMSG\": \"Approved Offline\",\n \"Message\": \"Approved\",\n \"AuthCode\": 145599,\n \"PNRef\": 810618212223,\n \"PaymentType\": \"Credit\",\n \"TransType\": \"Return\",\n \"SN\": 118816524647,\n \"ExtData\": {\n \"Amount\": \"0.01\",\n \"InvNum\": \"10\",\n \"CardType\": \"VISA\",\n \"BatchNum\": \"56\",\n \"Tip\": \"0.00\",\n \"CashBack\": \"0.00\",\n \"Fee\": \"0.00\",\n \"AcntLast4\": \"0281\",\n \"Name\": \"YOU/A GIFT FOR\",\n \"SVC\": \"0.00\",\n \"TotalAmt\": \"0.01\",\n \"DISC\": \"0.00\",\n \"Donation\": \"0.00\",\n \"SHFee\": \"0.00\",\n \"RwdPoints\": \"0\",\n \"RwdBalance\": \"0\",\n \"RwdIssued\": \"\",\n \"EBTFSLedgerBalance\": \"\",\n \"EBTFSAvailBalance\": \"\",\n \"EBTFSBeginBalance\": \"\",\n \"EBTCashLedgerBalance\": \"\",\n \"EBTCashAvailBalance\": \"\",\n \"EBTCashBeginBalance\": \"\",\n \"RewardCode\": \"\",\n \"AcqRefData\": \"\",\n \"ProcessData\": \"\",\n \"RefNo\": \"\",\n \"RewardQR\": \"\",\n \"Language\": \"English\",\n \"EntryType\": \"Swipe\",\n \"table_num\": \"0\",\n \"clerk_id\": \"\",\n \"ticket_num\": \"\",\n \"ControlNum\": \"\",\n \"TaxCity\": \"0.00\",\n \"TaxState\": \"0.00\",\n \"Cust1\": \"\",\n \"Cust1Value\": \"\",\n \"Cust2\": \"\",\n \"Cust2Value\": \"\",\n \"Cust3\": \"\",\n \"Cust3Value\": \"\",\n \"AcntFirst4\": \"4941\"\n },\n \"CVMResult\": 2,\n \"cancelled\": false,\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"printReceipt\": \"Both\",\n \"paymentType\": \"Credit\",\n \"type\": \"refund\",\n \"registerId\": \"4f1b-f10a\",\n \"registerStatusPort\": \"3594291\",\n \"registerNickname\": \"Tech Area Z8 (3594291)\",\n \"registerSerial\": \"124124\",\n \"registerType\": \"dejavoo\"\n },\n \"total\": 0.01,\n \"method\": \"card\",\n \"pre_auth\": false,\n \"is_captured\": 0,\n \"last_four\": \"5114\",\n \"interchange_code\": \"\",\n \"interchange_fee\": null,\n \"batch_id\": \"\",\n \"batched_at\": \"2018-04-16 19:09:37\",\n \"emv_response\": \"\",\n \"avs_response\": \"\",\n \"cvv_response\": \"\",\n \"pos_entry\": \"\",\n \"pos_salesperson\": \"\",\n \"receipt_email_at\": null,\n \"receipt_sms_at\": null,\n \"created_at\": \"2018-04-16 19:09:37\",\n \"updated_at\": \"2018-04-16 19:09:37\",\n \"total_refunded\": 0,\n \"is_refundable\": false,\n \"is_voided\": false,\n \"is_voidable\": false,\n \"schedule_id\": null,\n \"child_captures\": [],\n \"parent_auth\": null,\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n },\n \"child_transactions\": [],\n \"files\": [],\n \"payment_method\": {\n \"id\": \"bf1aee65-dad9-4b74-8800-a75e435e3e7b\",\n \"customer_id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"merchant_id\": \"27fad5e4-0210-4c91-9596-417b0ea0dbb1\",\n \"user_id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"nickname\": \"VISA: YOU/A GIFT FOR (ending in: 0281)\",\n \"has_cvv\": 0,\n \"is_default\": 1,\n \"method\": \"card\",\n \"person_name\": \"YOU/A GIFT FOR\",\n \"card_type\": \"visa\",\n \"card_last_four\": \"0281\",\n \"card_exp\": \"992099\",\n \"bank_name\": null,\n \"bank_type\": null,\n \"bank_holder_type\": null,\n \"address_1\": null,\n \"address_2\": null,\n \"address_city\": null,\n \"address_state\": null,\n \"address_zip\": \"\",\n \"address_country\": \"\",\n \"purged_at\": null,\n \"deleted_at\": null,\n \"created_at\": \"2018-04-16 19:09:36\",\n \"updated_at\": \"2018-04-16 19:09:36\",\n \"card_exp_datetime\": \"2107-03-31 23:59:59\",\n \"customer\": {\n \"id\": \"2a503ed1-99ea-4b35-a30a-605253f7c05a\",\n \"firstname\": \"A\",\n \"lastname\": \"Customer\",\n \"company\": \"\",\n \"email\": \"\",\n \"cc_emails\": [],\n \"cc_sms\": null,\n \"phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"address_country\": \"USA\",\n \"notes\": \"\",\n \"reference\": \"\",\n \"options\": \"\",\n \"created_at\": \"2018-02-23 22:32:19\",\n \"updated_at\": \"2018-02-23 22:32:19\",\n \"deleted_at\": null,\n \"allow_invoice_credit_card_payments\": true,\n \"gravatar\": false\n }\n },\n \"user\": {\n \"id\": \"dbc85118-3309-4129-b966-0108c0fb18a0\",\n \"system_admin\": true,\n \"name\": \"David Johnson\",\n \"email\": \"demo1@abc.com\",\n \"email_verification_sent_at\": \"2017-05-16 17:35:16\",\n \"email_verified_at\": \"2017-05-16 17:35:33\",\n \"is_api_key\": false,\n \"acknowledgments\": {\n \"tutorial\": true,\n \"godviewWelcome\": true\n },\n \"created_at\": \"2016-05-12 15:57:19\",\n \"updated_at\": \"2018-04-16 18:08:55\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null,\n \"merchant_options\": [],\n \"is_portal\": false\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "4be11b7e-21cb-4c9e-ba8f-5e173d13d7b7"
},
"invoice_id": {
"type": "string",
"example": ""
},
"reference_id": {
"type": "string",
"example": "5114aea7-5c7f-40ab-8a62-84f239e4b2b1"
},
"recurring_transaction_id": {
"type": "string",
"example": ""
},
"auth_id": {},
"type": {
"type": "string",
"example": "refund"
},
"source": {
"type": "string",
"example": "terminalservice.dejavoo"
},
"is_merchant_present": {
"type": "boolean",
"example": true,
"default": true
},
"merchant_id": {
"type": "string",
"example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1"
},
"user_id": {
"type": "string",
"example": "dbc85118-3309-4129-b966-0108c0fb18a0"
},
"customer_id": {
"type": "string",
"example": "2a503ed1-99ea-4b35-a30a-605253f7c05a"
},
"payment_method_id": {
"type": "string",
"example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b"
},
"is_manual": {
"type": "boolean",
"example": true,
"default": true
},
"success": {
"type": "boolean",
"example": true,
"default": true
},
"message": {
"type": "string",
"example": ""
},
"meta": {
"type": "object",
"properties": {
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"type": "string",
"example": ""
},
"details": {
"type": "string",
"example": ""
},
"quantity": {
"type": "integer",
"example": 1,
"default": 0
},
"price": {
"type": "string",
"example": "0.01"
}
}
}
},
"subtotal": {
"type": "number",
"example": 0.01,
"default": 0
},
"tax": {
"type": "integer",
"example": 0,
"default": 0
},
"taxRate": {
"type": "integer",
"example": 10,
"default": 0
},
"isBulkInvoice": {
"type": "boolean",
"example": false,
"default": true
},
"taxOverride": {
"type": "boolean",
"example": false,
"default": true
},
"update_inventory": {
"type": "boolean",
"example": true,
"default": true
},
"reference": {
"type": "integer",
"example": 2477,
"default": 0
},
"RegisterId": {
"type": "integer",
"example": 3594291,
"default": 0
},
"ResultCode": {
"type": "integer",
"example": 0,
"default": 0
},
"RespMSG": {
"type": "string",
"example": "Approved Offline"
},
"Message": {
"type": "string",
"example": "Approved"
},
"AuthCode": {
"type": "integer",
"example": 145599,
"default": 0
},
"PNRef": {
"type": "integer",
"example": 810618212223,
"default": 0
},
"PaymentType": {
"type": "string",
"example": "Credit"
},
"TransType": {
"type": "string",
"example": "Return"
},
"SN": {
"type": "integer",
"example": 118816524647,
"default": 0
},
"ExtData": {
"type": "object",
"properties": {
"Amount": {
"type": "string",
"example": "0.01"
},
"InvNum": {
"type": "string",
"example": "10"
},
"CardType": {
"type": "string",
"example": "VISA"
},
"BatchNum": {
"type": "string",
"example": "56"
},
"Tip": {
"type": "string",
"example": "0.00"
},
"CashBack": {
"type": "string",
"example": "0.00"
},
"Fee": {
"type": "string",
"example": "0.00"
},
"AcntLast4": {
"type": "string",
"example": "0281"
},
"Name": {
"type": "string",
"example": "YOU/A GIFT FOR"
},
"SVC": {
"type": "string",
"example": "0.00"
},
"TotalAmt": {
"type": "string",
"example": "0.01"
},
"DISC": {
"type": "string",
"example": "0.00"
},
"Donation": {
"type": "string",
"example": "0.00"
},
"SHFee": {
"type": "string",
"example": "0.00"
},
"RwdPoints": {
"type": "string",
"example": "0"
},
"RwdBalance": {
"type": "string",
"example": "0"
},
"RwdIssued": {
"type": "string",
"example": ""
},
"EBTFSLedgerBalance": {
"type": "string",
"example": ""
},
"EBTFSAvailBalance": {
"type": "string",
"example": ""
},
"EBTFSBeginBalance": {
"type": "string",
"example": ""
},
"EBTCashLedgerBalance": {
"type": "string",
"example": ""
},
"EBTCashAvailBalance": {
"type": "string",
"example": ""
},
"EBTCashBeginBalance": {
"type": "string",
"example": ""
},
"RewardCode": {
"type": "string",
"example": ""
},
"AcqRefData": {
"type": "string",
"example": ""
},
"ProcessData": {
"type": "string",
"example": ""
},
"RefNo": {
"type": "string",
"example": ""
},
"RewardQR": {
"type": "string",
"example": ""
},
"Language": {
"type": "string",
"example": "English"
},
"EntryType": {
"type": "string",
"example": "Swipe"
},
"table_num": {
"type": "string",
"example": "0"
},
"clerk_id": {
"type": "string",
"example": ""
},
"ticket_num": {
"type": "string",
"example": ""
},
"ControlNum": {
"type": "string",
"example": ""
},
"TaxCity": {
"type": "string",
"example": "0.00"
},
"TaxState": {
"type": "string",
"example": "0.00"
},
"Cust1": {
"type": "string",
"example": ""
},
"Cust1Value": {
"type": "string",
"example": ""
},
"Cust2": {
"type": "string",
"example": ""
},
"Cust2Value": {
"type": "string",
"example": ""
},
"Cust3": {
"type": "string",
"example": ""
},
"Cust3Value": {
"type": "string",
"example": ""
},
"AcntFirst4": {
"type": "string",
"example": "4941"
}
}
},
"CVMResult": {
"type": "integer",
"example": 2,
"default": 0
},
"cancelled": {
"type": "boolean",
"example": false,
"default": true
},
"gatewayStatus": {
"type": "integer",
"example": 200,
"default": 0
},
"gatewayStatusText": {
"type": "string",
"example": "OK"
},
"printReceipt": {
"type": "string",
"example": "Both"
},
"paymentType": {
"type": "string",
"example": "Credit"
},
"type": {
"type": "string",
"example": "refund"
},
"registerId": {
"type": "string",
"example": "4f1b-f10a"
},
"registerStatusPort": {
"type": "string",
"example": "3594291"
},
"registerNickname": {
"type": "string",
"example": "Tech Area Z8 (3594291)"
},
"registerSerial": {
"type": "string",
"example": "124124"
},
"registerType": {
"type": "string",
"example": "dejavoo"
}
}
},
"total": {
"type": "number",
"example": 0.01,
"default": 0
},
"method": {
"type": "string",
"example": "card"
},
"pre_auth": {
"type": "boolean",
"example": false,
"default": true
},
"is_captured": {
"type": "integer",
"example": 0,
"default": 0
},
"last_four": {
"type": "string",
"example": "5114"
},
"interchange_code": {
"type": "string",
"example": ""
},
"interchange_fee": {},
"batch_id": {
"type": "string",
"example": ""
},
"batched_at": {
"type": "string",
"example": "2018-04-16 19:09:37"
},
"emv_response": {
"type": "string",
"example": ""
},
"avs_response": {
"type": "string",
"example": ""
},
"cvv_response": {
"type": "string",
"example": ""
},
"pos_entry": {
"type": "string",
"example": ""
},
"pos_salesperson": {
"type": "string",
"example": ""
},
"receipt_email_at": {},
"receipt_sms_at": {},
"created_at": {
"type": "string",
"example": "2018-04-16 19:09:37"
},
"updated_at": {
"type": "string",
"example": "2018-04-16 19:09:37"
},
"total_refunded": {
"type": "integer",
"example": 0,
"default": 0
},
"is_refundable": {
"type": "boolean",
"example": false,
"default": true
},
"is_voided": {
"type": "boolean",
"example": false,
"default": true
},
"is_voidable": {
"type": "boolean",
"example": false,
"default": true
},
"schedule_id": {},
"child_captures": {
"type": "array"
},
"parent_auth": {},
"customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "2a503ed1-99ea-4b35-a30a-605253f7c05a"
},
"firstname": {
"type": "string",
"example": "A"
},
"lastname": {
"type": "string",
"example": "Customer"
},
"company": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"cc_emails": {
"type": "array"
},
"cc_sms": {},
"phone": {
"type": "string",
"example": ""
},
"address_1": {
"type": "string",
"example": ""
},
"address_2": {
"type": "string",
"example": ""
},
"address_city": {
"type": "string",
"example": ""
},
"address_state": {
"type": "string",
"example": ""
},
"address_zip": {
"type": "string",
"example": ""
},
"address_country": {
"type": "string",
"example": "USA"
},
"notes": {
"type": "string",
"example": ""
},
"reference": {
"type": "string",
"example": ""
},
"options": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"example": "2018-02-23 22:32:19"
},
"updated_at": {
"type": "string",
"example": "2018-02-23 22:32:19"
},
"deleted_at": {},
"allow_invoice_credit_card_payments": {
"type": "boolean",
"example": true,
"default": true
},
"gravatar": {
"type": "boolean",
"example": false,
"default": true
}
}
},
"child_transactions": {
"type": "array"
},
"files": {
"type": "array"
},
"payment_method": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "bf1aee65-dad9-4b74-8800-a75e435e3e7b"
},
"customer_id": {
"type": "string",
"example": "2a503ed1-99ea-4b35-a30a-605253f7c05a"
},
"merchant_id": {
"type": "string",
"example": "27fad5e4-0210-4c91-9596-417b0ea0dbb1"
},
"user_id": {
"type": "string",
"example": "dbc85118-3309-4129-b966-0108c0fb18a0"
},
"nickname": {
"type": "string",
"example": "VISA: YOU/A GIFT FOR (ending in: 0281)"
},
"has_cvv": {
"type": "integer",
"example": 0,
"default": 0
},
"is_default": {
"type": "integer",
"example": 1,
"default": 0
},
"method": {
"type": "string",
"example": "card"
},
"person_name": {
"type": "string",
"example": "YOU/A GIFT FOR"
},
"card_type": {
"type": "string",
"example": "visa"
},
"card_last_four": {
"type": "string",
"example": "0281"
},
"card_exp": {
"type": "string",
"example": "992099"
},
"bank_name": {},
"bank_type": {},
"bank_holder_type": {},
"address_1": {},
"address_2": {},
"address_city": {},
"address_state": {},
"address_zip": {
"type": "string",
"example": ""
},
"address_country": {
"type": "string",
"example": ""
},
"purged_at": {},
"deleted_at": {},
"created_at": {
"type": "string",
"example": "2018-04-16 19:09:36"
},
"updated_at": {
"type": "string",
"example": "2018-04-16 19:09:36"
},
"card_exp_datetime": {
"type": "string",
"example": "2107-03-31 23:59:59"
},
"customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "2a503ed1-99ea-4b35-a30a-605253f7c05a"
},
"firstname": {
"type": "string",
"example": "A"
},
"lastname": {
"type": "string",
"example": "Customer"
},
"company": {
"type": "string",
"example": ""
},
"email": {
"type": "string",
"example": ""
},
"cc_emails": {
"type": "array"
},
"cc_sms": {},
"phone": {
"type": "string",
"example": ""
},
"address_1": {
"type": "string",
"example": ""
},
"address_2": {
"type": "string",
"example": ""
},
"address_city": {
"type": "string",
"example": ""
},
"address_state": {
"type": "string",
"example": ""
},
"address_zip": {
"type": "string",
"example": ""
},
"address_country": {
"type": "string",
"example": "USA"
},
"notes": {
"type": "string",
"example": ""
},
"reference": {
"type": "string",
"example": ""
},
"options": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"example": "2018-02-23 22:32:19"
},
"updated_at": {
"type": "string",
"example": "2018-02-23 22:32:19"
},
"deleted_at": {},
"allow_invoice_credit_card_payments": {
"type": "boolean",
"example": true,
"default": true
},
"gravatar": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "dbc85118-3309-4129-b966-0108c0fb18a0"
},
"system_admin": {
"type": "boolean",
"example": true,
"default": true
},
"name": {
"type": "string",
"example": "David Johnson"
},
"email": {
"type": "string",
"example": "demo1@abc.com"
},
"email_verification_sent_at": {
"type": "string",
"example": "2017-05-16 17:35:16"
},
"email_verified_at": {
"type": "string",
"example": "2017-05-16 17:35:33"
},
"is_api_key": {
"type": "boolean",
"example": false,
"default": true
},
"acknowledgments": {
"type": "object",
"properties": {
"tutorial": {
"type": "boolean",
"example": true,
"default": true
},
"godviewWelcome": {
"type": "boolean",
"example": true,
"default": true
}
}
},
"created_at": {
"type": "string",
"example": "2016-05-12 15:57:19"
},
"updated_at": {
"type": "string",
"example": "2018-04-16 18:08:55"
},
"deleted_at": {},
"gravatar": {
"type": "string",
"example": "//www.gravatar.com/avatar/1cd5aef1d36d07e495abb73061f857d4"
},
"team_admin": {},
"team_enabled": {},
"team_role": {},
"merchant_options": {
"type": "array"
},
"is_portal": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"success\": false,\n \"message\": \"User Cancelled\",\n \"gatewayStatus\": 200,\n \"gatewayStatusText\": \"OK\",\n \"cancelled\": true,\n \"status\": 400\n}"
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false,
"default": true
},
"message": {
"type": "string",
"example": "User Cancelled"
},
"gatewayStatus": {
"type": "integer",
"example": 200,
"default": 0
},
"gatewayStatusText": {
"type": "string",
"example": "OK"
},
"cancelled": {
"type": "boolean",
"example": true,
"default": true
},
"status": {
"type": "integer",
"example": 400,
"default": 0
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"validation\": \"register not found\",\n \"status\": 422,\n \"message\": \"Validation Error\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"validation": {
"type": "string",
"example": "register not found"
},
"status": {
"type": "integer",
"example": 422,
"default": 0
},
"message": {
"type": "string",
"example": "Validation Error"
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "The amount a customer is credited.",
"format": "float"
},
"printReceipt": {
"type": "string",
"enum": [
"Both",
"Merchant",
"Customer",
"No"
],
"default": "Both"
},
"paymentType": {
"type": "string",
"enum": [
"Credit",
"Debit",
"Check",
"Gift",
"Loyalty"
]
},
"customerId": {
"type": "string",
"description": "The id of the customer attributed to this credit."
},
"invoiceID": {
"type": "string",
"description": "The id of the invoice attributed to this charge."
},
"transactionId": {
"type": "string"
},
"register": {
"type": "string",
"description": "The id of the register performing this operation. This should be the 'id' value returned by GET /terminal/register. The card must be present for a refund operation."
},
"meta": {
"type": "array",
"items": {
"type": "string",
"format": "json"
}
}
},
"required": [
"total",
"register",
"transactionId"
]
}
}
}
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```