Skip to main content
GET
Get a recovery instruction

Authorizations

Authorization
string
header
required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode
string
required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$
externalInstructionId
string
required

Caller-assigned, opaque identifier of this recovery instruction. One instruction governs one Receivable.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

Accepted recovery instruction.

The accepted instruction and whether recovery for its Receivable is currently held.

externalInstructionId
string
required
Pattern: ^[A-Za-z0-9_-]{1,128}$
scope
object
required

The Receivable this instruction governs.

state
enum<string>
required

suspended means PayPathIQ withdrew the authority because the Source raised a restriction or Dispute after the instruction. Send a new revision to authorize again once the Source has cleared it.

Available options:
authorized,
withdrawn,
suspended
revision
integer
required
Required range: 1 <= x <= 9007199254740991
effectiveAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
recordedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
recoveryEntryMode
string
required
Allowed value: "explicit_instruction"
recoveryHeld
boolean
required

True while any hold prevents recovery for the Receivable right now.

holds
enum<string>[]
required

Closed categories of the holds currently preventing recovery. An authorized instruction never clears any of them.

Available options:
recovery_not_authorized,
collection_not_enabled,
source_restriction,
dispute,
source_stale,
other_protection,
reconciliation_hold