---
title: "Retrieve payment instruction"
method: GET
path: "/payment-instructions/{paymentInstructionId}"
tags: ["paymentInstructions"]
---

# Retrieve payment instruction

`GET /payment-instructions/{paymentInstructionId}`

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.

## Path parameters

- `paymentInstructionId` string, required

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns the current status of the requested payment instruction.

- PaymentInstruction
  - `status` 'canceled' | 'completed' | 'failure' | 'inProgress', required — 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.
  - `errorMessage` string — Description of the error that caused the instruction to fail. **Note:** We return this field only if the status is `failure`.
  - `link` Link — Object that contains HATEOAS links for the resource.
    - `rel` string, required — Indicates the relationship between the current resource and the target resource.
    - `method` string, required — HTTP method that you need to use with the target resource.
    - `href` string, required — URL of the target resource.
  - `paymentInstructionId` string, required — Unique identifier that we assigned to the payment instruction.

## Other responses

- `400` — Invalid request
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `404` — Resource not found
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)