Cancel refund instruction | Payroc

Use this method to cancel a refund instruction.

You can cancel a refund instruction only if its status is inProgress. To retrieve the status of a refund instruction, use our Retrieve Refund Instruction method.

To cancel a refund instruction, you need its refundInstructionId. Our gateway returned the refundInstructionId in the response of the Submit Refund Instruction method.

Use this method to cancel a refund instruction. You can cancel a refund instruction only if its status is `inProgress`. To retrieve the status of a refund instruction, use our [Retrieve Refund Instruction](https://docs.payroc.com/api/schema/payroc-cloud/refund-instructions/retrieve) method. To cancel a refund instruction, you need its refundInstructionId. Our gateway returned the refundInstructionId in the response of the [Submit Refund Instruction](https://docs.payroc.com/api/schema/payroc-cloud/refund-instructions/submit) method.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

refundInstructionIdstringRequired>=1 character<=36 characters

Unique identifier that we assigned to the refund instruction.

Response

Successful request. We canceled the refund instruction.

1	import requests
2
3	url = "https://api.payroc.com/v1/refund-instructions/a37439165d134678a9100ebba3b29597"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.delete(url, headers=headers)
8
9	print(response.json())

Authentication

Path parameters

Response

Errors