Retrieve payment instruction

Retrieve the current status of a specific payment instruction.

paymentInstructionIdstringRequired>=1 character<=36 characters

Unique identifier of the payment instruction.

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.

errorMessagestringOptional

Description of the error that caused the instruction to fail.

linkobjectOptional

Object that contains information about a HATEOAS link. If we can’t match a dispute to a transaction, we don’t return a ‘link’ object.

1	import requests
2
3	url = "https://api.payroc.com/v1/payment-instructions/e743a9165d134678a9100ebba3b29597"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"status": "completed",
3	"paymentInstructionId": "a37439165d134678a9100ebba3b29597",
4	"link": {
5	"rel": "payment",
6	"method": "GET",
7	"href": "https://api.payroc.com/v1/payments/M2MJOG6O2Y"
8	}
9	}