SchemaPayroc CloudRefund Instructions

Submit refund instruction

Submit an instruction request to initiate a refund on a payment device.

Path parameters

serialNumberstringRequired>=1 character<=64 characters

Serial number that identifies the merchant’s payment device.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

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

This endpoint expects an object.
processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
orderobjectRequired
Object that contains information about the refund.
operatorstringOptional>=0 characters<=50 characters
Operator who initiated the request.
customerobjectOptional
Object that contains the customer's contact details and address information.
ipAddressobjectOptional
Object that contains information about the IP address of the device that sent the request.
customizationOptionsobjectOptional
Object that contains available options to customize certain aspects of an instruction.

Response

Successful request. We accepted the refund instruction to process.
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 to check the resource.
  • failure – The instruction failed. Check the error message for more information.
  • inProgress – The instruction is currently in progress.
Allowed values:
refundInstructionIdstring>=1 character<=36 characters
Unique identifier that our gateway assigned to the instruction.
errorMessagestring or null
Description of the error that caused the instruction to fail.

Errors