refundInstructions

Retrieve refund instruction

Changed on

Use this method to retrieve information about a refund instruction.

To retrieve a refund instruction, you need its refundInstructionId. Our gateway returned the refundInstructionId in the response of the Submit Refund Instruction method.

Our gateway returns the status of the refund instruction. If the payment device completed the refund instruction, the response also includes a link to the refund.

get/refund-instructions/{refundInstructionId}

Request

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

Path parameters

refundInstructionIdstring required

Unique identifier that we assigned to the refund instruction.

Response

Successful request. Returns the current status of the requested 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

  • 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 refundInstructions_retrieve