signatureInstructions

Submit signature instruction

Changed on

Use this method to submit an instruction to capture a customer's signature on a payment device.

Our gateway returns information about the signature instruction and a signatureInstructionId, which you need for the following methods:

post/devices/{serialNumber}/signature-instructions

Request

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

Path parameters

serialNumberstring required

Serial number that identifies the merchant’s payment device.

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Response

Successful request. We accepted 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