paymentInstructions

Cancel payment instruction

Changed on

Use this method to cancel a payment instruction.

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

To cancel a payment instruction, you need its paymentInstructionId. Our gateway returned the paymentInstructionId in the response of the Submit Payment Instruction method.

delete/payment-instructions/{paymentInstructionId}

Request

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

Path parameters

paymentInstructionIdstring required

Unique identifier that we assigned to the payment instruction.

Response

Successful request. We canceled the payment instruction.

object required

Changes