Cancel payment instruction | Payroc

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.

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](https://docs.payroc.com/api/schema/payroc-cloud/payment-instructions/retrieve) method. To cancel a payment instruction, you need its paymentInstructionId. Our gateway returned the paymentInstructionId in the response of the [Submit Payment Instruction](https://docs.payroc.com/api/schema/payroc-cloud/payment-instructions/submit) method.

Authentication

AuthorizationBearer

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

Path parameters

paymentInstructionIdstringRequired1-36 characters

Unique identifier that we assigned to the payment instruction.

Response

Successful request. We canceled the payment instruction.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

409

Conflict Error

500

Internal Server Error

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.PayrocCloud.PaymentInstructions;
4
5	namespace Usage;
6
7	public class Example
8	{
9	public async Task Do() {
10	var client = new PayrocClient();
11
12	await client.PayrocCloud.PaymentInstructions.DeleteAsync(
13	new DeletePaymentInstructionsRequest {
14	PaymentInstructionId = "e743a9165d134678a9100ebba3b29597"
15	}
16	);
17	}
18
19	}