API Reference

Configuring API Credentials

Use the Pay1st Console to generate the API Credentials for your integration

Used in Gateway Integration

Overview

The Pay1st Console needs to be configured to generate the API credentials required for a Gateway Integration.

Security Model

The Gateway Integration uses the following security model:

  • An API Keyand API Secret is randomly generated and used for authentication when generating an Access Token
  • All non-authentication based Gateway API endpoints use
    • An Access Tokenfor authentication with a Gateway API
    • A Signatureto verify that the incoming request was not tampered

It is recommended that all tokens are generated on the partner backend system and passed through the client.

List of Credentials

The following credentials can be generated on the Pay1st Console

Credential NameDescription
API KeyUsed together with the API Secret when integrating the Authentication - Generate Access Token API
API SecretUsed together with the API Key when integrating the Authentication - Generate Access Token API
Signing KeyThis credential is used when signing API Requests