Skip to main content
This guide starts with a balance read, so you can check your connection and authentication before creating a payment.
1

Get access

Request a business account through ledig.io and complete onboarding. Contact support@ledig.io for sandbox access.
2

Create an API key

Ask your business administrator to create an API key in the dashboard. For this example, the key needs the balances:read permission or read-only access. Save the secret when it is shown; you cannot view it again.
3

Choose Sandbox

Set the API URL:
Add LEDIG_API_KEY and LEDIG_API_SECRET to your application’s server-side secret configuration. Use your sandbox credentials.
4

Check the connection

The health endpoint does not require authentication:
A successful response is:
5

Read your USD balance

Use the Node.js or Python authentication example to call GET /v1/balances/USD. It calculates a fresh signature and sends the required headers for you.The balance fields in a successful response look like this. These are fictional amounts:
available is the amount you can use. reserved is set aside for payments in progress. See Balances for the full response and balance behaviour.
6

Build your payment flow

Follow Funding to receive money or Quotes to convert currencies and send payments. Test the flows your application needs before switching to Live.
If a request fails, use Errors and troubleshooting. If a payment request times out, follow the retry rules to avoid creating a duplicate.