paymentInstructions

Submit payment instruction

Changed on

Use this method to submit an instruction request to initiate a sale on a payment device.

In the request, include the order amount and currency.

When you send a successful request, our gateway returns information about the payment instruction and a paymentInstructionId, which you need for the following methods:

post/devices/{serialNumber}/payment-instructions

Request

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

Path parameters

serialNumberstring required

Serial number of 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

operatorstring

Operator who initiated the request.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

autoCaptureboolean

Indicates if we should automatically capture the payment amount.

  • true - Run a sale and automatically capture the transaction.
  • false- Run a pre-authorization and capture the transaction later.

Note: If you send false and the terminal doesn't support pre-authorization, we set the transaction's status to pending. The merchant must capture the transaction to take payment from the customer.

processAsSaleboolean

Indicates if we should immediately settle the sale transaction. The merchant cannot adjust the transaction if we immediately settle it.
Note: If the value for processAsSale is true, the gateway ignores the value in autoCapture.

Response

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

paymentInstructionIdstring required

Unique identifier that we assigned to the payment instruction.

Changes