Skip to main content

Simulate a Wire Transfer

Overview​

test with dummy data

Do not enter production data in the Highnote Test environment, which is for exploring features and training. Use only dummy or test data.

Wire transfers are used to transfer funds into a Highnote product funding account. For more information on product funding accounts, see Add Funds to your Balance.

This guide provides steps for simulating wire transfers using the Highnote API.

Prerequisites​

Simulate a wire transfer​

In the Test environment, use the following mutation to simulate a wire transfer to fund your product funding account:

SimulateDeposit​
Query
mutation SimulateDeposit($input: SimulateDepositInput!) {
  simulateDeposit(input: $input) {
    __typename
    ... on UserError {
      errors {
        errorPath
        code
        description
      }
    }
  }
}
Variables
{
  "input": {
    "amount": {
      "value": 1500,
      "currencyCode": "USD"
    },
    "toFinancialAccountId": "MC40LmFj",
    "memo": "",
    "source": "WIRE"
  }
}
⚠️ Please login to execute queries. Visit the dashboard to authenticate.
Result
{
  "data": {
    "simulateDeposit": {
      "__typename": "Transfer"
    }
  },
  "extensions": {
    "requestId": "19070e66-2fd9-968a-94be-85c4836eae7b"
  }
}

Find wire transfers​

After a wire transfer is initiated, you can use the Highnote API to find incoming and outgoing wire transfers. The direction of a wire transfer is defined as follows:

  • Incoming: Money is coming into a Highnote financial account via wire transfer.
  • Outgoing: Money is leaving a Highnote financial account via wire transfer.

Incoming wire transfers​

Use the following query to find an incoming wire transfer:

NodeWireTransfer​
Query
query NodeWireTransfer($id: ID!) {
  node(id: $id) {
    __typename
    ... on WireTransfer {
      id
      amount {
        value
        currencyCode
      }
      createdAt
      updatedAt
      memo
      type
      status
      financialAccount {
        id
      }
    }
  }
}
Variables
{
  "id": "WIRE_TRANSFER_ID"
}
⚠️ Please login to execute queries. Visit the dashboard to authenticate.
Result
{
  "data": {
    "node": {
      "__typename": "WireTransfer",
      "id": "WIRE_TRANSFER_ID",
      "amount": {
        "value": 2000,
        "currencyCode": "USD"
      },
      "createdAt": "1970-01-01T00:01:00.000Z",
      "updatedAt": "1970-01-01T00:02:00.000Z",
      "memo": "This is an incoming wire transfer",
      "type": "INCOMING_WIRE_TRANSFER",
      "status": "COMPLETED",
      "financialAccount": {
        "id": "FINANCIAL_ACCOUNT_ID"
      }
    }
  }
}

Outgoing wire transfers​

Use the following query to find an outgoing wire transfer:

NodeWireTransfer​
Query
query NodeWireTransfer($id: ID!) {
  node(id: $id) {
    __typename
    ... on WireTransfer {
      id
      amount {
        value
        currencyCode
      }
      createdAt
      updatedAt
      memo
      type
      status
      financialAccount {
        id
      }
    }
  }
}
Variables
{
  "id": "WIRE_TRANSFER_ID"
}
⚠️ Please login to execute queries. Visit the dashboard to authenticate.
Result
{
  "data": {
    "node": {
      "__typename": "WireTransfer",
      "id": "WIRE_TRANSFER_ID",
      "amount": {
        "value": 2000,
        "currencyCode": "USD"
      },
      "createdAt": "1970-01-01T00:01:00.000Z",
      "updatedAt": "1970-01-01T00:02:00.000Z",
      "memo": "This is an outgoing wire transfer",
      "type": "OUTGOING_WIRE_TRANSFER",
      "status": "COMPLETED",
      "financialAccount": {
        "id": "FINANCIAL_ACCOUNT_ID"
      }
    }
  }
}