Retrieve funding instructions for your NadaPay account so your team can add balance before generating quotes or executing transactions.

⏱️
Time to integrate: Most teams can validate this endpoint in under 5 minutes once authentication is working and they know which currency or account they need to fund.

What this endpoint does

Use this endpoint to retrieve the instructions required to fund your NadaPay account.

Depending on the funding flow, the response may include details such as virtual bank account information for fiat funding or wallet address information for crypto funding.

This endpoint is typically used by treasury, finance operations, or backend systems preparing an account for later transaction execution.

When to call this endpoint

Call this endpoint when you need to:

fund an organization account before generating a quote or executing a transaction
retrieve the destination details your finance or treasury team should use for a deposit
support a production launch where live balances must be established first
investigate how to add funds when a balance check shows insufficient funds

In most flows, you call this endpoint after identifying the account or currency you need to fund and before retrying a balance check.

Why deposit instructions matter

Funding is often the last operational dependency before a transaction can move from setup to execution.

Retrieving deposit instructions helps your team:

use the correct funding destination for the intended account
avoid sending funds to the wrong bank account or wallet address
coordinate treasury actions with engineering and operations
reduce delays during launch and live transaction preparation

For enterprise teams, this endpoint is a bridge between application integration and treasury operations.

Authentication

Send your API key in the x-api-key header on every request.

Item	Value
Authentication method	API key
Required header	`x-api-key`
Rate limit scope	Per API key

Recommended workflow

Use this endpoint in the funding and execution sequence:

Fetch organization accounts.
Check verification status.
Check the required currency balance.
If balance is insufficient, retrieve deposit instructions.
Fund the account using the returned instructions.
Recheck the balance.
Generate a quote.
Execute the transaction.

What to prepare before retrieving deposit instructions

Before sending the request, confirm the funding context your workflow requires.

At minimum, your team should confirm:

which organization account or currency needs funding
whether the funding flow is fiat or crypto
which internal team or system will initiate the deposit
whether the instructions are intended for sandbox testing or production treasury operations

⚠️
Needs confirmation: Exact request parameters, whether the endpoint requires account ID or currency context, supported funding rails, and any environment-specific funding behavior should be confirmed in the API definition.

How to use the response

Use the returned deposit instructions as the source of truth for where funds should be sent.

You will typically use the response to:

provide treasury or finance teams with deposit details
automate internal funding workflows
associate a funding action with the correct account or currency
recheck balances after the funding action completes

Recommended decision flow

If deposit instructions are returned successfully:

record which account or currency the instructions apply to
pass the instructions to the treasury or funding workflow
wait for funding to complete
recheck the balance before generating a quote or executing a transaction

If funding is delayed or not reflected yet:

do not assume the account is ready
recheck balance using the currency balance or account endpoints
investigate funding status before retrying execution

Common use cases

Fund a live account before launch

Use this endpoint during production readiness to fund the source account your first live transactions will use.

Recover from insufficient funds

If a quote or execution flow is blocked by low balance, retrieve deposit instructions, fund the account, then recheck balance.

Support treasury operations

Use this endpoint in back-office workflows where operations teams need current funding details for a specific account or currency.

Production notes

Before using this endpoint in production:

Define who is allowed to retrieve and act on deposit instructions.
Make sure funding instructions are shared only through secure internal channels.
Recheck balances after funding instead of assuming immediate availability.
Log which internal operator or system initiated the funding workflow.

Treat funding instructions as sensitive operational data because they directly affect where money is sent.

Common failure cases

Authentication fails

Check these items first:

the x-api-key header is present
the API key belongs to the intended environment
the base URL is correct

The returned instructions do not match expectations

If the funding details look wrong:

confirm you are requesting instructions for the correct environment
confirm the correct account or currency context is being used
confirm the intended funding rail matches your treasury workflow

Funding is sent but balance is still not available

If the account does not reflect funding yet:

recheck the balance before retrying any transaction flow
confirm the deposit was sent using the correct instructions
verify whether the funding method has processing or settlement delay
keep launch or execution paused until the balance is confirmed

Treasury and engineering are out of sync

If one team believes the account is funded but the API shows otherwise:

use the balance endpoint as the operational source of truth
compare the funding instructions used against the intended account context
document who initiated the deposit and when

⚠️
Needs confirmation: Exact response fields, funding settlement timing, support for one-time versus reusable instructions, and whether instructions can expire should be confirmed from the API schema and backend behavior.

Enterprise implementation notes

Access control

Restrict access to deposit instructions to trusted backend services and approved treasury or finance operators.

Auditability

Record:

the account or currency being funded
when deposit instructions were retrieved
the initiating service or user
the related funding action or treasury reference

Operational controls

Define internal procedures for:

funding approval
production launch funding checks
reconciliation between treasury actions and API-reported balances
incident handling when funding is sent to the wrong destination or not reflected as expected

Troubleshooting checklist

Use this checklist if funding readiness is blocking your flow:

Confirm authentication with x-api-key.
Confirm the correct environment is being used.
Confirm the correct account or currency needs funding.
Retrieve deposit instructions and pass them through the approved treasury workflow.
Recheck balance after funding.
Continue to quote or execution only after the balance is confirmed.

Recommended next endpoints

After you retrieve deposit instructions, continue with:

Related pages

Get Currency Balance

Recheck balance after funding before you generate a quote or execute a transaction.

Going Live

Review production funding readiness and treasury launch controls.

Generate Quote

Continue to pricing after the required funding is confirmed.