No keyDashboard

Money & account

Payments

Your balance by state, the commissions credited to it, and every withdrawal with its invoice.

How money moves

Commission travels through four stages before it reaches your bank, and the balance endpoint shows how much sits in each.

  • Pending: a network reports a conversion. It can still be rejected.
  • Awaiting: the network approves it, and it waits to be credited to your balance.
  • Available: the commission is credited to your balance as a transaction.
  • Withdrawn: you request a withdrawal in the dashboard, and it moves from pending to processing to paid.

Read-only, on purpose

The API can read every stage but cannot move money. Withdrawals are requested in the dashboard. Amounts here are your LinkApprove balance and carry no currency field.

Retrieve your balance

GEThttps://api.linkapprove.com/v1/payments/balancepayments:read

Returns the totals at each stage. Every figure is a two-decimal string.

Fields
pendingstring

Commission on conversions the network has reported but not approved yet. It can still be rejected.

awaitingstring

Commission the network has approved that has not been credited to your balance yet.

availablestring

Credited to your balance and not yet withdrawn.

withdrawals.pendingstring

Withdrawals you have requested that nobody has picked up yet.

withdrawals.processingstring

Withdrawals being paid out right now.

withdrawals.paidstring

Everything paid out to you, all time.

curl "https://api.linkapprove.com/v1/payments/balance" \
  -H "Authorization: Bearer $LINKAPPROVE_API_KEY"
Try it
GEThttps://api.linkapprove.com/v1/payments/balance
Get one

Held in this tab's session storage only, and reused by every runner on the site.

This panel replays the documented sample response and does not call the API. Copy a code sample to send a real request with your key.

List transactions

GEThttps://api.linkapprove.com/v1/payments/transactionspayments:read

Returns every commission credited to your balance, newest first. A transaction stays credited until a withdrawal includes it.

Query parameters
statusenum

credited or withdrawn.

pageinteger

1-based page number. Defaults to 1.

sizeinteger

Results per page, 1–100. Defaults to 10.

Fields
idinteger

The transaction ID.

amountstring

The credited amount.

statusenum

credited means it is in your available balance. withdrawn means a withdrawal included it.

withdrawalIdinteger | null

The withdrawal that paid it out. Null while credited.

programIdinteger | null

The program the commission came from, alongside merchantName.

createdAtstring

When it was credited.

curl "https://api.linkapprove.com/v1/payments/transactions?page=1&size=10" \
  -H "Authorization: Bearer $LINKAPPROVE_API_KEY"
Try it
GEThttps://api.linkapprove.com/v1/payments/transactions?page=1&size=10
Get one

Held in this tab's session storage only, and reused by every runner on the site.

This panel replays the documented sample response and does not call the API. Copy a code sample to send a real request with your key.

List withdrawals

GEThttps://api.linkapprove.com/v1/withdrawalspayments:read

Returns your withdrawals, newest first.

Query parameters
statusenum

pending, processing, paid, failed or cancelled.

pageinteger

1-based page number. Defaults to 1.

sizeinteger

Results per page, 1–100. Defaults to 10.

Fields
idinteger

The withdrawal ID.

amountstring

What you requested.

feesstring

Payout fees deducted.

netAmountstring

amount minus fees, which is what reaches you.

statusenum

pending, processing, paid, failed or cancelled.

paymentMethodobject | null

type (paypal, payoneer, bank_transfer or crypto) and a masked destination.

transactionReferencestring | null

The payment provider's reference, once paid.

invoiceUrlstring | null

A link to the PDF invoice, once paid. Treat it as opaque, since the host can change.

statusHistoryobject[]

Every status the withdrawal has been in, oldest first, with its timestamp.

createdAtstring

When you requested it.

Payout destinations are masked

An email shows its first letter and domain (j•••@example.com), and account numbers and wallet addresses show their last four characters (•••• 4821). Full details never leave the dashboard.

curl "https://api.linkapprove.com/v1/withdrawals?page=1&size=10" \
  -H "Authorization: Bearer $LINKAPPROVE_API_KEY"
Try it
GEThttps://api.linkapprove.com/v1/withdrawals?page=1&size=10
Get one

Held in this tab's session storage only, and reused by every runner on the site.

This panel replays the documented sample response and does not call the API. Copy a code sample to send a real request with your key.

Retrieve a withdrawal

GEThttps://api.linkapprove.com/v1/withdrawals/{id}payments:read

Returns one withdrawal. A withdrawal that does not exist or is not yours returns 404 withdrawal_not_found.

curl "https://api.linkapprove.com/v1/withdrawals/3301" \
  -H "Authorization: Bearer $LINKAPPROVE_API_KEY"
Try it
GEThttps://api.linkapprove.com/v1/withdrawals/3301
Get one

Held in this tab's session storage only, and reused by every runner on the site.

This panel replays the documented sample response and does not call the API. Copy a code sample to send a real request with your key.

PreviousReportsNextAccount