Toucan provides critical payment credentials and security data (cryptograms) for Pagos customers to use when allowing cardholders to transact. As such, we have gone beyond the simple API key approach to authentication and instead leverage a common HTTP REST-API pattern (AWS, Docusign, etc.) based on a keyed-HMAC (Hash Message Authentication Code) for authentication.
This guide outlines how a developer authenticates and proves their identity to access the Toucan service.
When you first onboard with Pagos Toucan, you’ll obtain the following credentials:
- A public ClientKey
- A private SecretKey
With every request you submit to Toucan, you must submit your public ClientKey, along with a message signature that you generate using your public ClientKey and your private Secret Key combined with the request message itself (e.g. the date and the JSON payload). These details will be combined inside the HTTP headers as part of every request, as shown below.
Once Pagos receives a request we’ll also calculate a signature; if they match, we’ll proceed with the request. Otherwise, an error will be returned and we’ll drop the request as not authorized.
Check out our provisioning a network token code example to see how the signature appears in a request to Toucan.
Authentication Signature HTTP Headers
All calls to Toucan must include an HMAC signature and at least these three headers:
|X-Date||UTC timestamp in ISO 8601 format||2022-07-28T16:05:32.00Z|
with optional microseconds and Z
|The date and time of the request|
|X-Client-Key||32 character string||538A4B83FEC409ECE24CE373A883A432|
|The public ClientKey you obtained during onboarding|
|Authorization||String||V1-HMAC-SHA256, Signature: Qj23jk3...(base64 encoded)||What your code will generate when making the request|
Authentication Signature Algorithm
The requester code will combine the following data elements to form a string, and then use a HMAC library to compute the sha256 digest in base64 format:
- Request Payload
Updated about 2 months ago