Sign in
Access Keys

Update Access Key

Update your access key

put/v1/aggregators/{raast-aggregator-id}/keys/{access-key-id}

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/keys/{access-key-id}
  • Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Path parameters

raast-aggregator-idstring required
Example:agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e

The unique identifier for the aggregator

access-key-idstring required
Example:ak_da8f1c10-346a-4be8-895a-b6187a9a9662

The unique identifier for the access key

Request body

is_activeboolean

Toggle indicating whether the key should be active

namestring

Updated label for the access key

Example request

{
  "name": "Updated Access Key"
}

Response

Successful operation

api_versionstring

The current version of the API spec

dataobject

Empty payload structure returned for successful operations without additional data

Example response

{
  "api_version": "v1",
  "data": {}
}

Changes

No recorded changes to this operation across all 1 revision of this API.