Skip to content

FraudDetectApi.md

Latest commit

 

History

History
194 lines (136 loc) · 11.7 KB

FraudDetectApi.md

File metadata and controls

194 lines (136 loc) · 11.7 KB

OpenapiClient::FraudDetectApi

All URIs are relative to https://cert.api.firstdata.com/gateway/v2

Method HTTP request Description
fraud_client_registration_post POST /fraud/client-registration Client registration for fraud detect transaction.
fraud_payment_registration_post POST /fraud/payment-registration Payment registration for fraud detect transaction.
score_only POST /fraud/score-only Score a transaction for fraud.

fraud_client_registration_post

FraudRegistrationResponse fraud_client_registration_post(content_type, client_request_id, api_key, timestamp, client_registration, opts)

Client registration for fraud detect transaction.

Use this to register client for fraud detect transaction.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::FraudDetectApi.new
content_type = 'application/json' # String | Content type.
client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
client_registration = OpenapiClient::ClientRegistration.new # ClientRegistration | 
opts = {
  message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
  region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
}

begin
  #Client registration for fraud detect transaction.
  result = api_instance.fraud_client_registration_post(content_type, client_request_id, api_key, timestamp, client_registration, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling FraudDetectApi->fraud_client_registration_post: #{e}"
end

Parameters

Name Type Description Notes
content_type String Content type. [default to 'application/json']
client_request_id String A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key String Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp Integer Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
client_registration ClientRegistration
message_signature String Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. [optional]
region String Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. [optional]

Return type

FraudRegistrationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

fraud_payment_registration_post

FraudRegistrationResponse fraud_payment_registration_post(content_type, client_request_id, api_key, timestamp, payment_registration, opts)

Payment registration for fraud detect transaction.

Use this to register payment for fraud detect transaction.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::FraudDetectApi.new
content_type = 'application/json' # String | Content type.
client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
payment_registration = OpenapiClient::PaymentRegistration.new # PaymentRegistration | 
opts = {
  message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
  region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
}

begin
  #Payment registration for fraud detect transaction.
  result = api_instance.fraud_payment_registration_post(content_type, client_request_id, api_key, timestamp, payment_registration, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling FraudDetectApi->fraud_payment_registration_post: #{e}"
end

Parameters

Name Type Description Notes
content_type String Content type. [default to 'application/json']
client_request_id String A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key String Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp Integer Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
payment_registration PaymentRegistration
message_signature String Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. [optional]
region String Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. [optional]

Return type

FraudRegistrationResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

score_only

ScoreOnlyResponse score_only(content_type, client_request_id, api_key, timestamp, score_only_request, opts)

Score a transaction for fraud.

Use this to obtain a fraud score for a transaction.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::FraudDetectApi.new
content_type = 'application/json' # String | Content type.
client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
score_only_request = OpenapiClient::ScoreOnlyRequest.new # ScoreOnlyRequest | Accepted request type: ScoreOnlyRequest.
opts = {
  message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
  region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
}

begin
  #Score a transaction for fraud.
  result = api_instance.score_only(content_type, client_request_id, api_key, timestamp, score_only_request, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling FraudDetectApi->score_only: #{e}"
end

Parameters

Name Type Description Notes
content_type String Content type. [default to 'application/json']
client_request_id String A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key String Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp Integer Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
score_only_request ScoreOnlyRequest Accepted request type: ScoreOnlyRequest.
message_signature String Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. [optional]
region String Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. [optional]

Return type

ScoreOnlyResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json