Sign in
paymentInstructions

Retrieve payment instruction

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}

Path parameters

paymentInstructionIdstring required

Unique identifier that we assigned to the payment instruction.

Headers

Authorizationstring required

Bearer authentication

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

No recorded changes to this endpoint across all 1 revision of this API.