refundPayment
Refund a cleared payment.
Arguments
Input fields for refunding a payment.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-3924: Unauthorized.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-3929: The payment is not in a refundable state.
- KT-CT-3933: Refund amount greater than payment amount.
- KT-CT-3937: Payment not eligible for refund.
- KT-CT-3938: Partial refund not allowed.
- KT-CT-7899: An internal error occurred.
Allowed Viewers
Required Permissions
Can refund paymentsQuery Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation RefundPayment($input: RefundPaymentInput!) {
refundPayment(input: $input) {
repayment {
...AccountRepaymentTypeFragment
}
}
}
Variables
{
"input": RefundPaymentInput
}
Response
{
"data": {
"refundPayment": {
"repayment": AccountRepaymentType
}
}
}