{"title":"Partially refund a balance","category":"default","creationDate":1776961627,"content":"

POS Object<\/h2>\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
POS<\/code><\/td>\nPOS object representing the cash register application.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

You can partially refund a tender where the PSP reference has been generated, and where it is unknown. You will need to implement both types of partial refund.<\/p>\n

Where the PSP reference is known:<\/h2>\n

Method<\/h3>\n<\/colgroup>

Name<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

RefundPspReference<\/code><\/p><\/td>

Call used to initiate a partial refund where the PSP reference is known.<\/p><\/td><\/tr><\/tbody><\/table>\n

Request<\/h3>\n<\/colgroup>

Name<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

RefundTransactionRequest<\/code><\/p><\/td>

Sent with the partial refund call where the PSP reference is known.<\/p><\/td><\/tr><\/tbody><\/table>\n

RefundPspReference\u00a0Parameters<\/h3>\n<\/colgroup>
Name<\/th>

Type<\/p><\/th>

Required<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

merchantAccount<\/code><\/p><\/td>

String<\/p><\/td>

\"-white_check_mark-\"<\/p><\/td>

The merchant account that is canceling the transaction and refunding the money (if applicable).<\/p><\/td><\/tr>

PSPReference<\/code><\/td>String<\/td>\"-white_check_mark-\"<\/td>

PSP reference of the current transaction.<\/p><\/td><\/tr>

originalPspReference<\/code><\/td>String<\/td>\"-white_check_mark-\"<\/td>PSP reference of the original transaction.<\/td><\/tr>
modificationAmountValue<\/code><\/td>Amount<\/td>\"-white_check_mark-\"<\/td>A container for the amount that needs to be refunded.<\/td><\/tr>
modificationAmountCurrency<\/code><\/td>Long<\/td>\"-white_check_mark-\"<\/td>

The three-character\u00a0ISO currency code<\/a>. The\u00a0currency<\/code>\u00a0must match the currency used in the original payment request.<\/p>

\u00a0<\/p><\/td><\/tr>

value<\/code><\/td>String<\/td>\"-white_check_mark-\"<\/td>

The\u00a0value<\/code>\u00a0must be less than or equal to the authorized amount.<\/p><\/td><\/tr><\/tbody><\/table>\n

Where the PSP reference is not known:<\/h2>\n

Method<\/h3>\n

Name<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

RefundTenderReference<\/code><\/p><\/td>

Call used to initiate a partial refund where the PSP reference is unknown.<\/p>

This can happen when the original Sale transaction was performed offline, in which case there will be no PSPReference, since this is generated only in an online situation.<\/p><\/td><\/tr><\/tbody><\/table>\n

Request<\/h3>\n<\/colgroup>

Name<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

RefundTransactionRequest<\/code><\/p><\/td>

Sent with the partial refund call where the PSP reference is unknown. Use the tender reference instead of the PSP reference.<\/p><\/td><\/tr><\/tbody><\/table>\n

RefundTenderReference\u00a0Parameters<\/h3>\n<\/colgroup>

Name<\/p><\/th>

Type<\/p><\/th>

Required<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

merchantAccount<\/code><\/p><\/td>

String<\/p><\/td>

\"-white_check_mark-\"<\/p><\/td>

The merchant account that is canceling the transaction and refunding the money (if applicable).<\/p><\/td><\/tr>

uniqueTerminalId<\/code><\/td>Long<\/td>\"-white_check_mark-\"<\/td>

Unique terminal ID to reference the PED that is processing the request.<\/p><\/td><\/tr>

tenderReference<\/code><\/td>String<\/td>\"-white_check_mark-\"<\/td>Reference for the transaction, used as the PSP reference is not available.<\/td><\/tr>
reference<\/code><\/td>String<\/td>\"-white_check_mark-\"<\/td>Reference for the merchant, used in reporting.<\/td><\/tr>
modificationAmountValue<\/code><\/td>Amount<\/td>\"-white_check_mark-\"<\/td>A container for the amount that needs to be refunded.<\/td><\/tr>
modificationAmountCurrency<\/code><\/td>Long<\/td>\"-white_check_mark-\"<\/td>

The three-character\u00a0ISO currency code<\/a>. The\u00a0currency<\/code>\u00a0must match the currency used in the original payment request.<\/p><\/td><\/tr><\/tbody><\/table>\n

Callback<\/h3>\n<\/colgroup>
Name<\/th>Description<\/th><\/tr><\/thead>

RefundCB<\/code><\/p><\/td>

Refund Callback returns the result of a partial refund, as well as any errors.<\/p><\/td><\/tr><\/tbody><\/table>\n

The response contains a\u00a0pspResultObj<\/code>. This object contains a getResponse method which should return a result of \"refund-received<\/strong><\/span>\". The response also includes the following parameters:<\/p>\n<\/colgroup>

Name<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

pedResult<\/code><\/p><\/td>

int<\/p><\/td>

Result denoting whether an error occurred on the PED.\u00a0A value of 0 means no error occurred.<\/td><\/tr>

pspResult<\/code><\/p><\/td>

int<\/p><\/td>

Result denoting whether an error occurred on the PSP.\u00a0A value of 0 means no error occurred.<\/td><\/tr>
libResult<\/code><\/td>int<\/td>Result denoting whether an error occurred in the Library. A value of 0 means no error occurred.<\/td><\/tr>
errorMessage<\/code><\/td>String<\/td>Reference for the transaction, used as the PSP reference is not available.<\/td><\/tr><\/tbody><\/table>","url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/cancel-or-refund-a-transaction-com-extension\/partially-refund-a-balance-com","articleFields":{"id":"31504782","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/cancel-or-refund-a-transaction-com-extension\/partially-refund-a-balance-com","title":"Partially refund a balance","content":"POS Object\n\n\n\nName\nDescription\n\n\n\n\nPOS\nPOS object representing the cash register application.\n\n\n\nYou can partially refund a tender where the PSP reference has been generated, and where it is unknown. You will need to implement both types of partial refund.\nWhere the PSP reference is known:\nMethod\nNameDescriptionRefundPspReferenceCall used to initiate a partial refund where the PSP reference is known.\nRequest\nNameDescriptionRefundTransactionRequestSent with the partial refund call where the PSP reference is known.\nRefundPspReference\u00a0Parameters\nNameTypeRequiredDescriptionmerchantAccountStringThe merchant account that is canceling the transaction and refunding the money (if applicable).PSPReferenceStringPSP reference of the current transaction.originalPspReferenceStringPSP reference of the original transaction.modificationAmountValueAmountA container for the amount that needs to be refunded.modificationAmountCurrencyLongThe three-character\u00a0ISO currency code. The\u00a0currency\u00a0must match the currency used in the original payment request.\u00a0valueStringThe\u00a0value\u00a0must be less than or equal to the authorized amount.\nWhere the PSP reference is not known:\nMethod\nNameDescriptionRefundTenderReferenceCall used to initiate a partial refund where the PSP reference is unknown.This can happen when the original Sale transaction was performed offline, in which case there will be no PSPReference, since this is generated only in an online situation.\nRequest\nNameDescriptionRefundTransactionRequestSent with the partial refund call where the PSP reference is unknown. Use the tender reference instead of the PSP reference.\nRefundTenderReference\u00a0Parameters\nNameTypeRequiredDescriptionmerchantAccountStringThe merchant account that is canceling the transaction and refunding the money (if applicable).uniqueTerminalIdLongUnique terminal ID to reference the PED that is processing the request.tenderReferenceStringReference for the transaction, used as the PSP reference is not available.referenceStringReference for the merchant, used in reporting.modificationAmountValueAmountA container for the amount that needs to be refunded.modificationAmountCurrencyLongThe three-character\u00a0ISO currency code. The\u00a0currency\u00a0must match the currency used in the original payment request.\nCallback\nNameDescriptionRefundCBRefund Callback returns the result of a partial refund, as well as any errors.\nThe response contains a\u00a0pspResultObj. This object contains a getResponse method which should return a result of \"refund-received\". The response also includes the following parameters:\nNameTypeDescriptionpedResultintResult denoting whether an error occurred on the PED.\u00a0A value of 0 means no error occurred.pspResultintResult denoting whether an error occurred on the PSP.\u00a0A value of 0 means no error occurred.libResultintResult denoting whether an error occurred in the Library. A value of 0 means no error occurred.errorMessageStringReference for the transaction, used as the PSP reference is not available.","type":"page","locale":"pt","boost":13,"hierarchy":{"lvl0":"Home","lvl1":"Terminais","lvl2":"Deprecation of classic libraries","lvl3":"Library integrations","lvl4":"COM extension for Windows integration","lvl5":"Key steps","lvl6":"Cancel or refund a transaction","lvl7":"Partially refund a balance"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/point-of-sale","lvl2":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation","lvl3":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations","lvl4":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration","lvl5":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension","lvl6":"https:\/\/docs.adyen.com\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/cancel-or-refund-a-transaction-com-extension","lvl7":"\/pt\/point-of-sale\/classic-library-deprecation\/classic-library-integrations\/com-extension-for-windows-integration\/key-steps-com-extension\/cancel-or-refund-a-transaction-com-extension\/partially-refund-a-balance-com"},"levels":8,"category":"In-person payments","category_color":"green","tags":["Partially","refund","balance"]}}