# Flash Payments Developer API ## Flash Payments Developer API - [Overview](https://developer.flash-payments.com/readme.md): Flash Payments Developer API documentation - [Why GraphQL](https://developer.flash-payments.com/basics/why-graphql.md): General information how to start using Flash Payments API - [Sending data as JSON](https://developer.flash-payments.com/basics/sending-data-as-json.md): Here is how to send your data to us as JSON instead of embedding it into the GraphQL queries. - [Authentication](https://developer.flash-payments.com/basics/authentication.md): Get your access token - [Required fields](https://developer.flash-payments.com/basics/required-fields.md): Here is how to identify the mandatory input fields for your GraphQL queries and mutations. - [Webhooks](https://developer.flash-payments.com/basics/webhooks.md): Two types of the webhooks - [Ad hoc webhooks](https://developer.flash-payments.com/basics/webhooks/adhoc-webhooks.md): How to secure your callback endpoints - [Regular webhooks](https://developer.flash-payments.com/basics/webhooks/regular-webhooks.md): How to setup web hooks for your integration - [API change log](https://developer.flash-payments.com/basics/api-change-log.md): History of changes to this API schema - [Master Balance](https://developer.flash-payments.com/accounts/master-balance.md): Query your master account balances - [Statement](https://developer.flash-payments.com/accounts/master-balance/statement.md): Understand every movement of your primary balance - [Virtual account numbers](https://developer.flash-payments.com/accounts/virtual-account-numbers.md): Generate named Virtual Account Numbers (aka sub-clients) for your clients' for collection - [Create sub-clients](https://developer.flash-payments.com/accounts/virtual-account-numbers/create-sub-clients.md) - [Sub-client statuses](https://developer.flash-payments.com/accounts/virtual-account-numbers/sub-client-statuses.md): Sub-client VANs lifecycle - [Disable, Activate and Update sub-clients](https://developer.flash-payments.com/accounts/virtual-account-numbers/disable-activate-and-update-sub-clients.md) - [Query sub-clients](https://developer.flash-payments.com/accounts/virtual-account-numbers/query-sub-clients.md) - [Payouts](https://developer.flash-payments.com/moving-funds/payouts.md): Disburse your money to a third party bank account - [Withdraw funds](https://developer.flash-payments.com/moving-funds/payouts/withdraw-funds.md): Send money from your Flash Payments balances to Australian bank accounts or internationally per your approved use case. - [Withdrawal statuses](https://developer.flash-payments.com/moving-funds/payouts/withdrawal-statuses.md): Withdrawal processing statuses - [Withdrawal outcomes simulation](https://developer.flash-payments.com/moving-funds/payouts/withdrawal-outcomes-simulation.md): Test common payout outcomes in UAT, as you build and exercise your integration solution against the full range of real-life withdrawal flows, statuses and webhooks before going live. - [Query withdrawals](https://developer.flash-payments.com/moving-funds/payouts/query-withdrawals.md) - [Rejection codes](https://developer.flash-payments.com/moving-funds/payouts/rejection-codes.md): How to handle a payout rejection - [Deposits](https://developer.flash-payments.com/moving-funds/deposits.md): Explains how to accept deposits programmatically - [Deposit statuses](https://developer.flash-payments.com/moving-funds/deposits/deposit-statuses.md): Deposit processing statuses - [Query deposits](https://developer.flash-payments.com/moving-funds/deposits/query-deposits.md) - [Refund deposits](https://developer.flash-payments.com/moving-funds/deposits/refund-deposits.md): Return the funds back to the original sender - [Senders](https://developer.flash-payments.com/moving-funds/senders.md): CRUD queries for your payment senders - [Recipients](https://developer.flash-payments.com/moving-funds/recipients.md): CRUD queries for your payment recipients - [Delivery methods](https://developer.flash-payments.com/moving-funds/recipients/delivery-methods.md): Different countries support different account types, transfer mechanisms, payment delivery methods. - [Institutions](https://developer.flash-payments.com/moving-funds/institutions.md): CRUD queries for Institutions - [Quote](https://developer.flash-payments.com/fx/quote.md): Quote the current bid and ask for a currency pair and size. - [Conversions](https://developer.flash-payments.com/fx/conversions.md): Convert between your multi-currency balances - [Convert funds](https://developer.flash-payments.com/fx/conversions/convert-funds.md): Convert between your multi-currency balances - [Query conversions](https://developer.flash-payments.com/fx/conversions/query-conversions.md): You can query all your past conversions - [Conversion statuses](https://developer.flash-payments.com/fx/conversions/conversion-statuses.md) - [FX Payments](https://developer.flash-payments.com/fx/payments.md): Convert and send your balance as single instruction - [Send funds](https://developer.flash-payments.com/fx/payments/send-funds.md): How to send orchestrated account-to-account payments which include FX - [Payment statuses](https://developer.flash-payments.com/fx/payments/payment-statuses.md) - [Query payments](https://developer.flash-payments.com/fx/payments/query-payments.md) - [Auto receive funds](https://developer.flash-payments.com/fx/payments/auto-receive-funds.md): Automatically receive and convert funds from other countries and currencies - [Request for Information](https://developer.flash-payments.com/compliance/request-for-information.md): Respond to compliance information requests programmatically - [RFI statuses](https://developer.flash-payments.com/compliance/request-for-information/rfi-statuses.md): RFI lifecycle statuses - [Query RFIs](https://developer.flash-payments.com/compliance/request-for-information/query-rfis.md): Retrieve your RFIs and their questions - [Answer RFI questions](https://developer.flash-payments.com/compliance/request-for-information/answer-rfi-questions.md): Submit answers with plaintext or documents - [Decline an RFI](https://developer.flash-payments.com/compliance/request-for-information/decline-an-rfi.md): When you cannot provide the requested information - [RFI response codes](https://developer.flash-payments.com/compliance/request-for-information/rfi-response-codes.md): All reply codes and GraphQL errors - [Confirmation of Payee](https://developer.flash-payments.com/compliance/confirmation-of-payee.md): Verify that a payee's account name matches their bank account details - [Testing CoP integration](https://developer.flash-payments.com/compliance/confirmation-of-payee/testing-cop-integration.md) - [CoP response codes](https://developer.flash-payments.com/compliance/confirmation-of-payee/cop-response-codes.md) - [Adverse Media Search](https://developer.flash-payments.com/compliance/adverse-media-search.md): Screen individuals and organisations against adverse media sources - [Run AMS Request](https://developer.flash-payments.com/compliance/adverse-media-search/run-ams-request.md) - [AMS statuses](https://developer.flash-payments.com/compliance/adverse-media-search/ams-statuses.md): Adverse media search request statuses - [Query AMS requests](https://developer.flash-payments.com/compliance/adverse-media-search/query-ams-requests.md) - [Bank information](https://developer.flash-payments.com/compliance/bank-information.md): Ensuring bank details are correct - [Address Cleanser](https://developer.flash-payments.com/compliance/address-cleanser.md): Validate and standardise physical addresses - [Cleanse an address](https://developer.flash-payments.com/compliance/address-cleanser/cleanse-an-address.md) - [Query Address Cleanser requests](https://developer.flash-payments.com/compliance/address-cleanser/query-address-cleanser-requests.md) - [Account members](https://developer.flash-payments.com/other/account-members.md): Retrieve the members of your client account - [Reference data](https://developer.flash-payments.com/other/reference-data.md) - [Rate limiting](https://developer.flash-payments.com/other/rate-limiting.md): How to avoid and resolve HTTP 429 Too Many Requests --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://developer.flash-payments.com/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.