SchemaPayroc CloudSignature Instructions

Retrieve signature instruction

Use this method to retrieve information about a signature instruction. To retrieve a signature instruction, you need its signatureInstructionId. Our gateway returned the signatureInstructionId in the response of the [Submit Signature Instruction](https://docs.payroc.com/api/schema/payroc-cloud/signature-instructions/submit) method. Our gateway returns the status of the instruction. If the payment device completed the instruction, the response also includes a link to retrieve the signature.

Path Parameters

signatureInstructionIdstringRequired1-36 characters
Unique identifier that our gateway assigned to the signature instruction.

Response

Successful request. Returns the signature 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.
Allowed values:
signatureInstructionIdstring1-36 characters
Unique identifier that our gateway assigned to the instruction.
errorMessagestring or null

Description of the error that caused the instruction to fail.

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

Errors