signatureInstructions

Retrieve signature instruction

Changed on

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 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.

get/signature-instructions/{signatureInstructionId}

Request

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

Path parameters

signatureInstructionIdstring required

Unique identifier that our gateway assigned to the signature instruction.

Response

Successful request. Returns the signature instruction.

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.
errorMessagestring

Description of the error that caused the instruction to fail.

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

signatureInstructionIdstring required

Unique identifier that our gateway assigned to the instruction.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id retrieve removed and replaced with signatureInstructions_retrieve