- Management API\u2014Terminal settings read and write<\/strong><\/li><\/ul>
If you have a Terminal API integration with cloud-based communications<\/a>, you can use the existing API key that you use for Terminal API requests.<\/td>\n<\/tr>\n\n Customer Area roles<\/a><\/strong><\/td>\n To enable unreferenced refunds using the Customer Area, you must have the following role: - Merchant POS Terminal Management<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
\n Webhooks<\/a><\/strong><\/td>\n Subscribe to the following webhook: - REFUND_WITH_DATA webhook<\/a><\/strong><\/li><\/ul><\/td>\n<\/tr>\n
\n Limitations<\/strong><\/td>\n Note the following limitations: - Due to anti-money laundering and payment industry regulations, it is not possible to enable unreferenced refunds for certain Merchant Category Codes (MCC)<\/a> and in the following countries:
- Brazil<\/li>
- Mexico<\/li>
- Australia<\/li>
- Malaysia<\/li>
- Singapore<\/li>
- Hong Kong<\/li>
- India<\/li><\/ul><\/li>
- It is not possible to make unreferenced refunds to a QR code wallet, such as Alipay and WeChat Pay. To refund these payment methods, you must make a referenced refund.<\/li><\/ul><\/td>\n<\/tr>\n
\n Setup steps<\/strong><\/td>\n To enable unreferenced refunds at the company or merchant account level, contact our Support Team<\/a>.
To enable unreferenced refunds on the store or for an individual terminal or mobile device, follow the setup steps for your Customer Area<\/a> or for making API calls<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nEnable unreferenced refunds<\/h2>\n
You can enable unreferenced refunds at the store or terminal level in two ways:<\/p>\n
- \n
- Through the Customer Area<\/a><\/li>\n
- By making API calls<\/a><\/li>\n<\/ul>\n
Optionally, contact our Support Team<\/a> to enable:<\/p>\n
- \n
- Enable unreferenced refunds at the company or merchant account level.<\/li>\n
- A refund delay, so you have time to cancel an unreferenced refund<\/a> when necessary.<\/li>\n<\/ul>\n
Enable through the Customer Area<\/h3>\n
To enable unreferenced refund for a store or for an individual terminal or mobile device through the Customer Area:<\/p>\n
- \n
- Log in to your Customer Area<\/a> and select the store or terminal.<\/li>\n
- Go to Terminal Settings<\/strong> > Payment features<\/strong> > Refund<\/strong>.<\/li>\n
- Under Unreferenced refunds<\/strong>, select Enabled<\/strong>.<\/li>\n
- Optionally, under Offline refund limit<\/strong>, select Add new currency limit<\/strong> and enter the maximum amount you want to allow for offline refunds..\n
\nDue to anti-money laundering and payment industry regulations, it is not always possible to enable unreferenced refunds. An error message will inform you if unreferenced refunds are not allowed:
Unreferenced refunds are not permitted for the country of this store.<\/code><\/li>Unreferenced refunds are not permitted for this account or store due to its merchant category code.<\/code><\/li><\/ul><\/p>\n<\/div><\/li>\n- Select Save<\/strong>.<\/li>\n<\/ol>\n
Enable with API calls<\/h3>\n
To enable unreferenced refunds at the store or terminal level using API calls:<\/p>\n
- \n
- \n
Make a PATCH request to the
\/terminalSettings<\/code> endpoint for the store or terminal.
\nUse one of the following endpoints:<\/p>\n- \n
- PATCH \/stores\/{storeId}\/terminalSettings<\/a><\/li>\n
- PATCH \/terminals\/{terminalId}\/terminalSettings<\/a><\/li>\n<\/ul>\n
In the request body include a
refunds<\/code> object with:<\/p>\n- \n
unreferenced.enableUnreferencedRefunds<\/code>: Indicates whether unreferenced refunds are enabled on the terminal or mobile device. Set this to true<\/strong><\/span> to enable unreferenced refunds.<\/li>\n<\/ul>\nThe following example shows how to enable unreferenced refunds on the terminal level.<\/p>\n
\n<\/code-sample>\n<\/div>\n \nDue to anti-money laundering and payment industry regulations, it is not always possible to enable unreferenced refunds. The example below shows an error message returned when unreferenced refunds cannot be enabled.<\/p>\n<\/div>\n
\n<\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n Make an unreferenced refund<\/h2>\n
\nFor an unreferenced refund to a gift card, you need to specify more parameters than we describe here. Refer to Make a refund to a gift card<\/a>.<\/p>\n<\/div>\n
- \n
- \n
Make a payment request<\/a>, specifying:<\/p>\n
- \n
- \n
The standard \n
SaleToPOIRequest.MessageHeader<\/code>\n<\/a> object, withMessageClass<\/code> set to Service<\/strong><\/span> andMessageCategory<\/code> set to Payment<\/strong><\/span>.<\/p>\n
- \n
- \n
- PATCH \/terminals\/{terminalId}\/terminalSettings<\/a><\/li>\n<\/ul>\n
- PATCH \/stores\/{storeId}\/terminalSettings<\/a><\/li>\n
- Go to Terminal Settings<\/strong> > Payment features<\/strong> > Refund<\/strong>.<\/li>\n
- Log in to your Customer Area<\/a> and select the store or terminal.<\/li>\n
- By making API calls<\/a><\/li>\n<\/ul>\n
- Through the Customer Area<\/a><\/li>\n
- Due to anti-money laundering and payment industry regulations, it is not possible to enable unreferenced refunds for certain Merchant Category Codes (MCC)<\/a> and in the following countries:
- REFUND_WITH_DATA webhook<\/a><\/strong><\/li><\/ul><\/td>\n<\/tr>\n
- Merchant POS Terminal Management<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
![\"-white_check_mark-\"](\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" "\\"-white_check_mark-\\"")
<\/td>\n