Skip to main content
Version: Lab (preview)

instruction

QUERY

Returns instruction.

Arguments

merchant_uidRequired
ID
The Pay Theory unique identifier assigned to the merchant.
dateRequired
AWSDate
The instruction date in YYYY-MM-DD format (UTC).

Response

ArrayInstruction
id
ID
The unique instruction identifier.
merchant_uid
ID
The Pay Theory unique identifier assigned to the merchant.
date
AWSDate
The instruction date in YYYY-MM-DD format (UTC).
amount
String
The instruction amount, in cents as a 64-bit string.
status
InstructionStatus
The current status of the instruction.
Values
CANCELEDFAILEDPENDINGPROCESSED
scheduled_processing_date
AWSDateTime
The scheduled processing date/time for the instruction (UTC).
settlement_batch
Int| null
The settlement batch number assigned after processing (if any).
metadata
AWSJSON| null
Optional metadata attached to the instruction.