paymentInstructions

Retrieve payment instruction

Changed on

Use this method to retrieve information about a payment instruction.

To retrieve a payment instruction, you need its paymentInstructionId. Our gateway returned the paymentInstructionId in the response of the Submit Payment Instruction method.

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

get/payment-instructions/{paymentInstructionId}

Request

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

Path parameters

paymentInstructionIdstring required

Unique identifier that we assigned to the payment instruction.

Response

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

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