refundInstructions

Cancel refund instruction

Changed on

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.

delete/refund-instructions/{refundInstructionId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/refund-instructions/{refundInstructionId}
  • Auth
    HTTP bearer

Path parameters

refundInstructionIdstring required

Unique identifier that we assigned to the refund instruction.

Response

Successful request. We canceled the refund instruction.

object required

Changes