API overview

Start your Starks integration by choosing the workflow you need and sending your secret key in the x_starks_api_key header.

Start here

1. Read Getting Started with Starks.
2. Generate a secret key in your Starks dashboard.
3. Choose your environment base URL:

4. Add x_starks_api_key: <your-secret-key> to your requests.
5. Add Content-Type: application/json to your requests.
6. If you call Initialize payout, also include the signature header described on that endpoint. Use the same secret key to generate that signature.

Choose a workflow

• Authentication
• Accept a payment
• Send a payout
• Create a currency conversion
• Track settlements

Reference by area

Banks

• Get list of banks
• Bank account enquiry

Beneficiaries

• Create beneficiary
• Get beneficiaries
• Delete beneficiary

Pay-ins

• Get payin metadata
• Initialize payin payment
• Get payin balances
• Get payin transaction history

Payouts

• Get payout metadata
• Initialize payout
• Initialize bulk payout
• Get payout history
• Get payout balances

Conversions

• Get currency pair rates
• Create currency conversion
• Get conversion logs

Settlements

• Get pending settlement payins
• Get settlement batches
• Get settlement payins

Response basics

• 2xx: Your request succeeded or returned data.
• 4xx: Review your x_starks_api_key header, validation, and request format before retrying.
• 5xx: Retry after confirming that you are using the correct environment and request body.

Next step

If this is your first integration, start with Getting Started with Starks.