Accept a payment
Create a payin payment link, confirm supported payin options, and track transaction status through the payin endpoints.
Create a payin payment link and then track its status through the payin endpoints.
Before you start
- Generate a Client Secret Key in your Starks dashboard.
- Review Authentication so your headers are correct before you send requests.
- Choose the base URL for the environment you are using.
1. Read payin metadata
Use Get payin metadata to confirm the available currencies, payment channels, and providers before you create a payin.
This step keeps your initialization request aligned with the options the API currently supports.
2. Initialize the payin
Use Initialize payin payment to create a new payin payment link for processing.
Store the response from this call so you can trace the payment through the rest of the flow.
3. Track the transaction
Use Get payin transaction history to review the status of initialized payins and reconcile completed activity.
Check this endpoint whenever you need to confirm whether a payin was created, is still pending, or has already moved forward in your process.
Optional: Check balances
Use Get payin balances when you need the current organization balances by currency.
Use balances for an account-level view. Use transaction history for payment-level status.
Optional: Common mistakes
- Skipping Get payin metadata and then sending unsupported currency or provider values.
- Treating balances as a replacement for Get payin transaction history when you need the status of a specific payin.
- Not storing the initialization response that you need for later tracking and reconciliation.
Updated 3 days ago