Skip to content

InformationLookupApi.md

Latest commit

 

History

History
132 lines (92 loc) · 8.08 KB

InformationLookupApi.md

File metadata and controls

132 lines (92 loc) · 8.08 KB

OpenapiClient::InformationLookupApi

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

Method HTTP request Description
card_info_lookup POST /card-information Card information lookup.
lookup_account POST /account-information Account information lookup.

card_info_lookup

CardInfoLookupResponse card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)

Card information lookup.

Use this to look up card related information such as issuer country, card function and card brand.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::InformationLookupApi.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).
card_info_lookup_request = OpenapiClient::CardInfoLookupRequest.new # CardInfoLookupRequest | Accepted request type: CardInfoLookupRequest.
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
  #Card information lookup.
  result = api_instance.card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling InformationLookupApi->card_info_lookup: #{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).
card_info_lookup_request CardInfoLookupRequest Accepted request type: CardInfoLookupRequest.
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

CardInfoLookupResponse

Authorization

No authorization required

HTTP request headers

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

lookup_account

CardInfoLookupResponse lookup_account(content_type, client_request_id, api_key, timestamp, account_info_lookup_request, opts)

Account information lookup.

Use this to look up card related information associated with a payment card or payment token.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::InformationLookupApi.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).
account_info_lookup_request = OpenapiClient::AccountInfoLookupRequest.new # AccountInfoLookupRequest | Accepted request type: PaymentCardInfoLookupRequest and PaymentTokenInfoLookupRequest
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
  #Account information lookup.
  result = api_instance.lookup_account(content_type, client_request_id, api_key, timestamp, account_info_lookup_request, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling InformationLookupApi->lookup_account: #{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).
account_info_lookup_request AccountInfoLookupRequest Accepted request type: PaymentCardInfoLookupRequest and PaymentTokenInfoLookupRequest
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

CardInfoLookupResponse

Authorization

No authorization required

HTTP request headers

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