SchemaPayroc CloudPayment Instructions

Retrieve payment instruction

Retrieve the current status of a specific payment instruction.

Path parameters

paymentInstructionIdstringRequired>=1 character<=36 characters
Unique identifier of the payment instruction.

Headers

AuthorizationstringRequired

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

Response

Successful request. Returns the current status of the requested payment instruction.
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:
paymentInstructionIdstring>=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