organizationVirtualAccountsPage

Parameters

Parameter Type Required
pagination PaginationInput true
filters [FilterInput] false

FilterInput

Key Sample Value
incoming_transfer_account_id ["922a11ff-55fb-4b9c-8f0c-be6a07337e99", ...]
state ["accepted", ...]
entity_id ["4e4b460a-0aa0-484c-ba66-a20488962709", ...]
purpose_of_payment ["payroll", ...]
bank_name ["Santander", ...]
account_holder_type ["business", ...]
tax_number ["MEX123456", ...]
name_on_bank_account ["Some Business", ...]
nicename_on_bank_account ["my super nice name", ...]
organization_id ["de17b99e-2ff9-49eb-afb4-03a30460bbc0", ...]
email ["derek@jeter.com", ...]
currency ["MXN", ...]
id ["b787112e-e248-4fee-9160-7383f3fe160c", ...]
entity_name ["NY Yankees", ...]
account_type ["checking", ...]
bank_country ["MX", ...]
account_number ["123456789012345678", ...]
wallet_id ["35deb238-c515-4948-95de-1fb7351bbbd1", ...]

Query

var axios = require('axios');

var data = JSON.stringify({
  query: `query organizationVirtualAccountsPage(
    $search_terms: String
    $pagination: PaginationInput!
    $filters: [FilterInput]
    ) {
        organizationVirtualAccountsPage(
        search_terms: $search_terms
        pagination: $pagination
        filters: $filters
        ) {
        items {
            id
            currency
            created_date
            updated_date
            balance
            client_friendly_name
            account_name
            account_iban
            account_number
            master_account_iban
            master_account_number
            state
            organization {
                id
                identifier
            }
            entity {
            id
            entity_name
            }
        }
        pagination {
            page
            page_size
            pages_total
            items_total
        }
        updated_date
        }
    }`,
  variables: {"pagination":{"page":1,"page_size":20}}
});

var config = {
  method: 'post',
  url: 'https://sandbox.external.routefusion.com/graphql',
  headers: {
    'Authorization': 'Bearer <your token>',
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Example Response

{
    "data": {
        "organizationVirtualAccountsPage": {
            "items": [{...}, {...}],
            "pagination": {
                "page": 1,
                "page_size": 0,
                "pages_total": 0,
                "items_total": 0
            },
            "updated_date": null
        }
    }
}