Skip to main content
GET
/
v1
/
transfers
/
{transferId}
Get a transfer
curl --request GET \
  --url https://api.waycore.com/v1/transfers/{transferId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "batchId": "<string>",
  "connectionId": "<string>",
  "sourceAccountId": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "rail": "internalTransfer",
  "status": "queued",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "destinationAccountId": "<string>",
  "counterparty": {
    "name": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "swiftBic": "<string>",
    "bankName": "<string>",
    "bankCountry": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "line2": "<string>",
      "region": "<string>",
      "postalCode": "<string>"
    }
  },
  "memo": "<string>",
  "executionDate": "2023-12-25",
  "failureReason": "<string>",
  "matchedTransactionId": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

Authorization
string
header
required

OAuth 2.0 Client Credentials issuing JWT Bearer access tokens.

Path Parameters

transferId
string
required

Query Parameters

fields
string | null

Comma-separated sparse fieldset. The server always includes required identifiers.

Response

Successful Response

id
string
required

Stable, immutable identifier for the transfer.

batchId
string
required

Identifier grouping transfers submitted in the same request.

connectionId
string
required

Identifier of the connection used for execution.

sourceAccountId
string
required

Identifier of the source account.

amount
string
required

Transfer amount as a decimal string.

Pattern: ^\d+(?:\.\d{1,18})?$
currency
string
required

Transfer currency code.

Pattern: ^[A-Z0-9]{3,12}$
rail
enum<string>
required

Payment rail used for the transfer.

Available options:
internalTransfer,
ach,
wire,
swift,
fednow,
rtp
status
enum<string>
required

Current transfer status.

Available options:
queued,
executing,
pendingBankApproval,
completed,
failed,
cancelled
createdAt
string<date-time>
required

When the transfer was created.

updatedAt
string<date-time>
required

When the transfer record last changed.

destinationAccountId
string | null

Identifier of the destination account, for internal transfers.

counterparty
Counterparty · object

Counterparty details, for external transfers. Sensitive fields may be masked in responses.

memo
string | null

Transaction memo or description.

Maximum string length: 140
executionDate
string<date> | null

Scheduled execution date.

failureReason
string | null

Reason for failure, when status is failed.

matchedTransactionId
string | null

Identifier of the reconciled transaction in GET /transactions, once the transfer is confirmed on the bank statement.

completedAt
string<date-time> | null

When the transfer reached a terminal status (completed, failed, or cancelled).

metadata
Metadata · object

Opaque client-defined metadata.