API Introduction
You can use the FraudShield APIs to submit a single transaction for risk processing.
The FraudShield APIs are organised around REST. They have predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. JSON is returned by all API responses, including errors.
Majority of the fields are optional to provide and only relate to certain fraud scenarios, but if a rule you have created contains logic around a specific field it must be provided for the rule to be evaluated correctly.
For information about how a transaction is processed, see the Transaction Flow guide.
Authentication​
- API Key: ApiKeyAuth
All API Authentication is done by including an Authorization header in your API request containing your API key. Example code is provided in many popular programming languages on each API page.
The API Key can be generated from the FraudShield dashboard under your account from the API Keys page. API Keys are environment specific, Production and Test, and will dictate which environment the transaction will be sent to automatically, so ensure you use the correct key in each request.
When generating a new key, select a meaningful key name, along with an expiration date if required (leaving the expiration date empty will set the key to never expire). Only a maximum of 5 keys per environment type can be active at a time.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |