action velopayments_payor_create_api_key_v1 { label: "Create API Key" description: "

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

\n

You can create multiple API Keys for a given application

\n

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

\n" provider: velopayments method: POST path: "/v1/payors/{payorId}/applications/{applicationId}/keys" encoding: json input: { type: "object" properties: { applicationId: { type: "string" format: "uuid" } description: { type: "string" description: "Description of the key." } name: { type: "string" description: "A name for the key." } payorId: { type: "string" format: "uuid" } roles: { type: "array" description: "

A role to assign to the key.

\n

If you want your API key to have write access then assign the role velo.payor.admin

\n

A later version will change this property from a list to string

\n" items: { type: "string" description: "Name of role" enum: ["velo.payor.admin", "velo.payor.support"] } } } required: ["applicationId", "name", "payorId", "roles"] additionalProperties: false } output: { type: "object" properties: { apiKey: { type: "string" format: "uuid" description: "API Key" } apiSecret: { type: "string" format: "uuid" description: "API Secret" } } } }