List collateral top-ups
Changed onRetrieve a paginated list of collateral top-ups credited to your account, including the asset legs and processing fees for each payment. Records are returned newest first by createdAt.
All funding methods are returned by default; use repaymentMethod to narrow to a specific rail. Date filters apply to createdAt; paidDate and verifiedDate are returned on every record so they can be filtered client-side.
Records of every status are included unless you filter on status — created, pending_review and failed records are listed alongside completed ones so the extract is complete. When reconciling funds received, filter to completed and sum creditedAmount.
Monetary amounts are returned as strings to preserve precision. Fiat currencies use ISO 4217 alpha-3 codes; asset codes under assets are provider-supplied (e.g. USDT) and are not ISO codes.
Request
- Base URLhttps://sandbox.api.caas.reap.global
- AuthAPI key in header x-reap-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The page number to retrieve in a paginated response. (default: 1, min: 1, max: 10000)
A limit on the number of records to be returned. (default: 50, max: 100)
Filter by status. Repeatable. One or more of: created, paid, completed, failed, pending_review.
Filter by funding method. Repeatable. One or more of: manual, bank_transfer, direct_debit, crypto, van_transfer, crypto_top_up, crypto_triple_a, fiat_collateral.
Inclusive lower bound on createdAt, as a YYYY-MM-DD date. Taken as the start of that UTC day.
Inclusive upper bound on createdAt, as a YYYY-MM-DD date. Taken as the end of that UTC day (23:59:59.999Z).
Headers
Specifies the API version to use for this request.
Response
Return collateral top-ups list
Changes
- info
endpoint added
- info