Skip to main content
POST
/
v1
/
aggregators
/
{raast-aggregator-id}
/
keys
Create Access Key
curl --request POST \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/keys \
  --header 'Content-Type: application/json' \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>' \
  --data '
{
  "is_active": true,
  "name": "Developer Access Key"
}
'
{
  "api_version": "v1",
  "data": {
    "id": "ak_cf0f7821-32f5-4c66-8e86-0d5e2bb8b6b9",
    "token": "ak_tok_b758ad9a",
    "key_id": "key_live_a31b23f0",
    "aggregator_id": "agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e",
    "is_active": true,
    "name": "Developer Access Key",
    "secret": "sk_live_GZc5k9mT0n",
    "created_at": "2025-05-19T11:19:12.000Z",
    "updated_at": "2025-05-19T11:19:12.000Z"
  }
}

Authorizations

​
X-SFPY-AGGREGATOR-SECRET-KEY
string
header
required

Path Parameters

​
raast-aggregator-id
string
required

The unique identifier for the aggregator

Example:

"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e"

Body

application/json

Request to create a new access key

Defines the attributes required to create a new access key

​
is_active
boolean
required

Indicates whether the newly created access key should be enabled immediately

Example:

true

​
name
string
required

Human-readable label that helps distinguish this access key

Example:

"Developer Access Key"

Response

This response contains details of an access key

Standard response structure for successful operations

​
api_version
string

The current version of the API spec

Example:

"v1"

​
data
object

Newly created access key resource