Refund a PaymentRequest.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

For detailed information on how to use this API and specific merchant use cases for this API, please refer to this API reference guides documentation: PaymentRequestAPI

Error Codes

CodeStatusReasonWhat to do
ERR0.03400Refunds can only be done on COMPLETE, RETURN_COMPLETE or RETURN_FAILED paymentsCheck the status of the refund. Note that RETURN_IN_PROGRESS refunds can not have a second refund completed against them, and a second attempt should be delayed by several seconds until the initial refund has reached a terminal status.
ERR0.05400Missing IDSupply the paymentRequestID.
ERR0.06400Refund amount value must be a numberSupply a decimal value for the refund.
ERR0.07400Refunds cannot be done against PaymentRequest's with multiPayment set to trueEnsure the refund is against a non multi-payment paymentRequest. If attempting to target a child transaction of a multipayment, ensure you use the child payment's paymentRequestID
ERR0.08400Refunds can only be done on COMPLETE, RETURN_COMPLETE or RETURN_FAILED paymentsCheck the status of the refund. Note that RETURN_IN_PROGRESS refunds can not have a second refund completed against them, and a second attempt should be delayed by several seconds until the initial refund has reached a terminal status.
ERR0.09400Refund for this client can only be for the full amountRefund the full amount if a refund is required.
ERR0.10400Refund amount must be less than or equal to original payment amountEnsure the refund amount does not exceed the balance available on the transaction to process the refund.
ERR0.11400Insufficient balance in the settlement accountEnsure your float account has available balance to process the refund.
ERR0.12400Client Refund ID must be between 5 and 100 characters.Supply a refund ID that is between the specified length.
404Payment Request not found.Confirm the PaymentRequest exists.

Query Params
string
required
number
string
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json