POST Api/Auth

Requests an access token to access the PayIQ API

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
APIKey	Transactis Provided – This uniquely identifies a biller.	globally unique identifier	Required
CreationDate	Contains the creation date of the request in ISO 8601 format.	string	Required
grant_type	Credentials being requested. Must be "client_credentials".	string	Required
Role	Optionally specifies the role of the access token. Allowed values are "APIEBPPBillerCSR", "API1TCustomer" and "APICustomer". Transactis may choose to implement additional roles in the future. If omitted, defaults to APICustomer.	string	Matching regular expression pattern: ^API.*
Signature	Contains the user-generated digital signature that proves the identity of the incoming request.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "4d6b8b7a-393a-49e8-af19-c27bf19205b0",
  "CreationDate": "sample string 2",
  "Signature": "sample string 3",
  "grant_type": "sample string 4",
  "Role": "sample string 5"
}

Response Information

Resource Description

Requests an access token to access the PayIQ API

AuthResponseModel

Name	Description	Type	Additional information
access_token	Contains the access token granted to the client	string	None.
token_type	Contains the token type, will always be "Bearer"	string	None.

Response Formats

application/json, text/json

Sample:

{
  "access_token": "sample string 1",
  "token_type": "sample string 2"
}