The response to GETREFUNDSTATUS is the same as the REFUND response, but with an additional field reflecting the status of the GETREFUNDSTATUS call itself.
Output parameters for the GETREFUNDSTATUS call:
Field | Type | Description |
---|---|---|
REQUESTSTATUS | ascii | Possible values: • SUCCEEDED : the refund status values reflect the status of the referenced refund.• FAILED : the GETREFUNDSTATUS call failed. Check ERRMSG for details. |
REQUESTFAILREASON | ascii | Only returned if REQUESTSTATUS has FAILED. See REQUESTFAILREASON for possible values. |
STATUS | ascii | The outcome of the request. Possible values: • SUCCEEDED • FAILED |
REFUNDID | ascii | Unique refund identifier. Maximum 20 characters [a-zA-Z0-9.,-_]. In case of severe errors (e.g. authentication not possible) this will be “0”, otherwise a valid refund identifier is always assigned. |
MERCHANTREFUNDID | ascii | The value of the merchantrefundid parameter sent by the client in the REFUND request |
ERRMSG | utf8 | Human readable error message - up to 128 characters. |
FAILREASON | ascii | Returned only if STATUS is FAILED . Possible values:• UNKNOWN : the refund failed for unknown reasons (also default in reporting in case of succeeded refunds).• QUOTA : money-holding, AML or other banking regulations make in unable to fulfill the refund request.• LOCAL_ERROR : local system error. Contact Payment Gateway support.• REMOTE_ERROR : a remote processing error occurred. If this is not temporary, contact Payment Gateway support.• LOCAL_DECLINE : The Payment Gateway declined the refund, for example due to risk management.• REMOTE_DECLINE : a remote system declined the refund, for example due to a failed payment process authentication. |
SUCCEEDED response
REQUESTSTATUS=SUCCEEDED
&RAND1166608346=32f5503880cd1a0b47d3f16864e9a3584a52613b
&STATUS=SUCCEEDED
&REFUNDID=1234567890
&MERCHANTREFUNDID=MS123R
&ERRMSG=