Retrieve payment instruction | Payroc

Use this method to retrieve information about a payment instruction.

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

Our gateway returns the status of the payment instruction. If the payment device completed the payment instruction, the response also includes a link to the payment.

Use this method to retrieve information about a payment instruction. To retrieve 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. Our gateway returns the status of the payment instruction. If the payment device completed the payment instruction, the response also includes a link to the payment.

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. Returns the current status of the requested payment instruction.

statusenum

Indicates the current status of the instruction.

canceled – The instruction was canceled before it was completed.
completed – The instruction has completed. Use the link object to check the resource.
failure – The instruction failed. Check the errorMessage field for more information.
inProgress – The instruction is currently in progress.

Indicates the current status of the instruction. - `canceled` – The instruction was canceled before it was completed. - `completed` – The instruction has completed. Use the link object to check the resource. - `failure` – The instruction failed. Check the errorMessage field for more information. - `inProgress` – The instruction is currently in progress.

Allowed values:

paymentInstructionIdstring1-36 characters

Unique identifier that we assigned to the payment instruction.

errorMessagestring

Description of the error that caused the instruction to fail.

Note: We return this field only if the status is failure.

linkobjectRead-only

Object that contains HATEOAS links for the resource.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable 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.RetrieveAsync(
13	new RetrievePaymentInstructionsRequest {
14	PaymentInstructionId = "e743a9165d134678a9100ebba3b29597"
15	}
16	);
17	}
18
19	}

1	{
2	"status": "completed",
3	"paymentInstructionId": "a37439165d134678a9100ebba3b29597",
4	"link": {
5	"rel": "payment",
6	"method": "GET",
7	"href": "https://api.payroc.com/v1/payments/M2MJOG6O2Y"
8	}
9	}