Happy Business Starts Here

Highlighted
Zuora Alumni

How can I void a payment via API?

Question: I do not see any options to void payments via API.   How can I void a payment like in the UI?



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

2 REPLIES 2
Zuora Alumni

Re: How can I void a payment via API?

Answer: Voiding a payment will require that you update the status of the payment to "Voided".  Please be aware that this will send a void request to your gateway.

 

Below are examples in REST and SOAP API.

 

REST:

 

PUT: https://rest.zuora.com/v1/object/payment/{id}

 

{

"Status": "Voided"

}

 

SOAP:

 

soap.png



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

Scholar

Re: How can I void a payment via API?

Hi,

 

I have tested this API on the sandbox.

The response is success but I saw the status still is processed when I check on GUI.

REST PUT: https://rest.sandbox.eu.zuora.com/v1/object/payment/{id}

Body: {
"Status": "Voided"
}

Is there anything wrong here?

Thanks