{ "opencollection": "1.0.0", "info": { "name": "Overflow Open Campaigns Deposits API", "version": "3.0" }, "items": [ { "info": { "name": "Deposits", "type": "folder" }, "items": [ { "info": { "name": "Get Deposits", "type": "http" }, "http": { "method": "GET", "url": "https://server.stage.overflow.co/api/v3/deposits", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of deposits to return." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the deposits to return." }, { "name": "createdAt", "value": "", "type": "query", "description": "Filter deposits created on this date." }, { "name": "startDate", "value": "", "type": "query", "description": "Filter deposits whose arrival date is on or after this date." }, { "name": "endDate", "value": "", "type": "query", "description": "Filter deposits whose arrival date is on or before this date." }, { "name": "ids", "value": "", "type": "query", "description": "Filter by deposit ids." }, { "name": "sortBy", "value": "", "type": "query", "description": "Field to sort deposits by. Defaults to arrival date." }, { "name": "sortDirection", "value": "", "type": "query", "description": "Sort direction. Defaults to descending." }, { "name": "search", "value": "", "type": "query", "description": "Free-text search across deposit fields." }, { "name": "reconciled", "value": "", "type": "query", "description": "Filter by reconciliation status." }, { "name": "minimumEstimatedValueInCents", "value": "", "type": "query", "description": "Filter deposits with net amount greater than or equal to this value, in cents." }, { "name": "maximumEstimatedValueInCents", "value": "", "type": "query", "description": "Filter deposits with net amount less than or equal to this value, in cents." }, { "name": "paymentMethod", "value": "", "type": "query", "description": "Filter by payment method types." }, { "name": "types", "value": "", "type": "query", "description": "Filter by deposit types." } ], "auth": { "type": "apikey", "key": "x-client-id", "value": "{{x-client-id}}", "placement": "header" } }, "docs": "\nReturns deposits for the nonprofit based on the provided filters. A deposit is a settlement from Overflow to the nonprofit's bank account.\n\n---\n\n### Deposit Status\n\n* `PENDING`: The deposit is awaiting processing.\n* `IN_TRANSIT`: The deposit has been initiated and is in transit to the bank.\n* `PAID`: The deposit has arrived in the bank account.\n* `FAILED`: The deposit failed to be processed.\n* `CANCELED`: The deposit was canceled before processing.\n\n---\n\n### Deposit Types\n\n* `AUTOMATED`: A sche" }, { "info": { "name": "Get Deposit", "type": "http" }, "http": { "method": "GET", "url": "https://server.stage.overflow.co/api/v3/deposits/:depositId", "params": [ { "name": "depositId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "x-client-id", "value": "{{x-client-id}}", "placement": "header" } }, "docs": "Returns a single deposit by its id for the authenticated nonprofit, including its line-item breakdown. All monetary amounts are expressed in cents." }, { "info": { "name": "Get Deposit Summary", "type": "http" }, "http": { "method": "GET", "url": "https://server.stage.overflow.co/api/v3/deposits/:depositId/summary", "params": [ { "name": "depositId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "x-client-id", "value": "{{x-client-id}}", "placement": "header" } }, "docs": "Returns aggregated totals (contributions, refunds, chargebacks, adjustments) for the deposit. All monetary amounts are expressed in cents." } ] } ], "bundled": true }