refundInstructions

Submit refund instruction

Changed on

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

In the request, include the refund amount and currency.

If the request is successful, our gateway returns information about the refund instruction and a refundInstructionId, which you need for the following methods:

post/devices/{serialNumber}/refund-instructions

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/devices/{serialNumber}/refund-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

operatorstring

Operator who initiated the request.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Response

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

refundInstructionIdstring required

Unique identifier that we assigned to the refund instruction.

Changes