API Reference

Create Api Credential

post
https://api-sandbox.urbanpayx.com/api/v1/auth/api-credentials

Create an API credential.

Issues a new API key and secret for server-to-server access, scoped to the
permissions of the selected role. The secret is shown only once at creation —
store it securely. Exchange the key and secret at the token endpoint to obtain
short-lived access tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255
string
enum
required

Role whose permissions the key inherits

Allowed:
string
enum
Defaults to role_template

Use the role's preset permissions or a custom set

Allowed:
array | null

Explicit permission keys, required when mode is custom

Headers
Responses

Updated 2 months ago

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

Updated 2 months ago