HomeAPI Reference
API Reference
API Reference
API Reference

List Ontop Balance transactions

get
https://api.stg.getontop.com/top-payins/v1/transactions/ontop_balance

Returns your Ontop Balance transactions, newest first: top-ups, payments and withdrawals.

List filters take comma-separated values (operation_types=TOP_UP,PAYMENT). Different filters combine with AND.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required

Your client ID, the id_client claim of your access token. Any other value returns 401.

integer
≥ 0
Defaults to 0

Page number, starting at 0.

integer
1 to 1000

Page size, up to 1000.

operation_types
array of strings

Transaction types, comma-separated.

  • TOP_UP: money added to your balance
  • PAYMENT: a payment made from your balance
  • WITHDRAW: money withdrawn from your balance
operation_types
Allowed:
payment_method_type_codes
array of strings

Payment methods, comma-separated.

  • USAWT: US wire
  • WT: international wire
  • ACH: ACH
  • ACHX: ACH Express
  • CRYEX: crypto
  • CC: credit card
  • PRPDF: Ontop Balance
  • LOCAL: local currency payment
payment_method_type_codes
transaction_statuses
array of objects

Statuses, comma-separated.

  • SUCCEEDED: completed
  • PENDING: waiting for the funds
  • RECEIPT_MISSING: waiting for you to upload a proof of payment
  • MISSING_LINK: waiting for a payment link
  • FAILED: failed or cancelled
transaction_statuses
date-time

Start of the range, YYYY-MM-DDTHH:mm:ssZ. Use with date_to.

date-time

End of the range, YYYY-MM-DDTHH:mm:ssZ. Use with date_from.

Responses

Updated about 11 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?