API docs by Redocly

Dashboard API Reference (1.0.0)

The Revenew Dashboard API is a backend-for-frontend (BFF) service for the Revenew Dashboard Web Application. Though this API is predominantly internal, it follows the same API design principles and release process as our public facing APIs.

Authentication

TODO

OAuth

Security Scheme Type: OAuth2
Flow type: clientCredentials
Token URL: https://auth.revenew.co/oauth/token
Scopes:
  • payments -

    View and manage payments

Payments

View and manage payments processed with external Payment Service Providers (PSPs)

List payments

Lists the payments for a specific account

Authorizations:
OAuth
query Parameters
accounts[]
Array of strings
Example: accounts[]=acc_4qw4prchxkr9p2a42mtfb3ewmz

The Revenew account identifiers for which payments should be returned. If omitted, all accounts linked to the authenticated user will be used.

offset
integer
Default: 0
Example: offset=20

The number of items to skip before starting to collect the result set. Used in combination with limit to enable paging responses.

limit
integer
Default: 10
Example: limit=10

The numbers of items to return. Used in combination with limit to enable paging responses.

period_from
string <date-time>
Example: period_from=2023-01-01

A date-time in ISO 8601 format for which all payments processed after should be returned

period_to
string <date-time>
Example: period_to=2023-01-15

A date-time in ISO 8601 format for which all payments processed before should be returned

Responses

Response Headers
Revenew-Trace-Id
string
Example: "96ce50247f87f540bb2d86771b3728b8"

The trace identifier for the request. It is a good idea to log this and provide it with any support requests

Revenew-Api-Version
string <semver>
Example: "1.5.6"

The version of the Revenew API

Response Schema: application/json
object

The query that was used to return the result

Array of objects

Payments that match the provided query parameters

total_count
integer <int64>

The total number of payments matching the query irrespective of paging parameters

required
object

Links related to the resource

Response samples

Content type
application/json
{
  • "query": {
    • "offset": 20,
    • "limit": 10
    },
  • "items": [
    • {
      • "id": "pay_4vh2vme2qgrrg7v8x8wzxewkx2",
      • "psp": "stripe",
      • "psp_id": "pi_3N9kHvJNSIruR1rb1Jkj755n",
      • "initiated_at": "2019-08-24T14:15:22Z",
      • "status": "succeeded",
      • "amount": {
        • "currency": "GBP",
        • "value_major": 10
        },
      • "reference": "ORD-12456-7",
      • "balance_amount": {
        • "currency": "USD",
        • "value_major": 12.36,
        • "exchange_rate": 1.2358207
        },
      • "reconciliation_status": "pending",
      • "recipients": [
        • {
          • "id": "acc_4qsgaebe1482affj8x3n2des44",
          • "name": "Craft Brew Co"
          }
        ],
      • "totals": {
        • "psp_fees_major": -0.68,
        • "recipients_allocations_major": -12.36,
        • "recipients_deductions_major": 1.44,
        • "recipients_net_major": -10.92,
        • "net_revenue_major": 0.76,
        • "net_margin_percent": 6.15
        }
      }
    ],
  • "total_count": 753,
  • "_links": {}
}