Quickstart

Create a sandbox account and transfer, simulate incoming funds, and receive a transfer status webhook.

1. Get a sandbox API key

Open the sandbox dashboard. In the platform dashboard, go to Developers > API keys; in the business portal, go to Settings > API keys. You can also issue a key with POST /v1/api_keys.

Use https://api.sandbox.due.network as your API base URL and send Authorization: Bearer dk_.... See Sandbox configuration and Authentication.

2. Create an account

Call POST /v1/accounts. Follow Creating accounts for the request format. As a platform, send Due-Account-Id: <accountId> on subsequent account-scoped calls.

3. Get the KYC link and approve the account

Call GET /v1/kyc to get the KYC (Know Your Customer) link. Approve the account using the tools in Sandbox configuration.

4. Accept the terms of service

Follow TOS Acceptance to accept the terms of service for the account.

5. Create a recipient

Call POST /v1/recipients to create the payment destination.

6. Get a quote

Call POST /v1/transfers/quote. Follow Quotes for the request format and save the returned quote token.

7. Create the transfer

Call POST /v1/transfers with the quote token and an externalId. See Transfer flow for transfer creation and tracking.

8. Simulate incoming funds

Call POST /dev/payin. Use the fiat pay-in example in Sandbox configuration.

9. Receive the transfer status event

Register your webhook endpoint using Using Webhooks, then receive transfer.status_changed as the transfer status changes. Verify each delivery using Webhook security.

For the event envelope and transfer payload, see Incoming Events.


Did this page help you?