Authenticate Requests

All REST Admin API queries require a valid Recurpay access token.

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

Public and Custom apps created in the Partner Dashboard generate tokens using OAuth, and custom apps made in the Recurpay admin are authenticated in the Recurpay admin.

Include your token in the X-Recurpay-Access-Token header for all API requests. To maintain platform security, apps must request specific access scopes during the app creation process. Request only the necessary data access for your app to function.

Path Params
string
enum
required
Defaults to 2024-07

Version of the API.

Allowed:
Headers
string
required

Include your token as a X-Recurpay-Access-Token header on all API queries for authenticating the admin API.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json