GitHub
PATH ADDRESS

SDK reference

Payment instructions

Obtain a destination for one payment, on one capability.

instruction(input)

For a request, no credential. For an address, the member credential.

const instruction = await path.instruction({
  request: request.reference,
  via: { rail: 'book', asset_type: 'fiat', asset_code: 'USD' },
});

instruction.beneficiary; // { format: "path_address", value: "path:4a91c2f7e8d3" }
instruction.status;      // "open"

via is one entry of the accepts in force. Pass endpointBase to ask the payee's member directly — the host that served the request.

readInstruction(reference)

No credential. 410 once the instruction is no longer open.

revokeInstruction(reference)

Requires the issuer's credential.

On this page