Skip to main content
POST
Get Access Token
No signature required for this call. Unlike other CommercePay endpoints, Authenticate does not require signature security checking — it’s how you obtain the credentials used to sign every other request.
Cache and reuse the access token across requests instead of calling it every time. Once it expires, requests using it will be rejected and you’ll need to call this endpoint again for a new one.

Headers

Abp-TenantId
string
required

Your unique Merchant ID assigned by CommercePay.

Body

application/json
userNameOrEmailAddress
string
required

Your merchant account username or email address, provided by CommercePay when your account is set up.

Maximum string length: 50
Example:

"merchant@yourcompany.com"

password
string
required

Your merchant account password, provided by CommercePay when your account is set up.

Maximum string length: 50
Example:

"your-password"

Response

Success

accessToken
string | null
required

Get the access token from the result and place it into the Authorization Bearer token type for security purposes.

expireInSeconds
integer<int32>

Number of seconds until the access token expires.

Example:

86400