v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payors

Create API Key

Create an an API key for the given payor Id and application Id

You can create multiple API Keys for a given application

API Keys are programmatic users for integrating your application with the Velo platform

The response will return the API Key and the secret. This is the only time you will be able to see the secret

post/v1/payors/{payorId}/applications/{applicationId}/keys

Path parameters

payorIdstring uuid required

The account owner Payor ID

applicationIdstring uuid required

Application ID

Request body

namestring required

A name for the key.

descriptionstring nullable

Description of the key.

rolesstring[] required

A role to assign to the key. If you want your API key to have write access then assign the role velo.payor.admin A later version will change this property from a list to string

Example request

{
  "roles": [
    "payor.admin"
  ],
  "name": "SAP Key 01",
  "description": "An API Key for the SAP Application"
}

Response

HTTP Ok, key created

apiKeystring uuid

API Key

apiSecretstring uuid

API Secret

Example response

{
  "apiKey": "385d4506-e7dd-446e-a092-5f30b98e7b26",
  "apiSecret": "f25767d9-342a-48ac-a788-0a7a38ae6fb3"
}