Skip to main content
GET
Get Transfer

Authorizations

Authorization
string
header
required

Opaque API key passed as Authorization: Bearer <key>. Keys are organization-bound, environment-bound (live or test), scope-carrying, and expiring. Create and manage keys via the console.

Path Parameters

id
string<uuid>
required

Stable transfer identifier.

Response

Successful Response

id
string<uuid>
required

Stable transfer identifier.

status
enum<string>
required

Current transfer lifecycle status. pending_bank_approval means Waycore has initiated the bank flow and the integrator should direct its user to approve in the bank portal.

Available options:
queued,
executing,
pending_bank_approval,
completed,
failed,
returned,
cancelled,
unknown
type
enum<string>
required

Transfer direction.

Available options:
internal,
external
requestedAmount
MoneyAmount · object
required

Amount requested by the caller.

Example:
sourceAccountId
string<uuid>
required

Source connected account identifier.

destination
InternalAccountDestination · object
required

Transfer destination.

transferType
enum<string>
required

Transfer rail used or requested.

Available options:
internal,
ach,
wire,
swift,
fednow,
rtp,
sepa,
local
clientReference
string
required

Integrator-supplied payment reference distinct from the idempotency key. Where supported by the bank, this is the reference sent with the payment.

createdAt
string<date-time>
required

When the transfer was created.

updatedAt
string<date-time>
required

When the transfer last changed.

executedAmount
MoneyAmount · object | null

Actual amount sent once execution is known.

Example:
memo
string | null

Integrator-visible memo.

failureReason
TransferFailureReason · object | null

Failure details when status is failed, returned, or cancelled.