Skip to content

Latest commit

 

History

History
150 lines (112 loc) · 9.68 KB

InformationLookupApi.md

File metadata and controls

150 lines (112 loc) · 9.68 KB

openapi_client.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, message_signature=message_signature, region=region)

Card information lookup.

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

Example

from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InformationLookupApi()
content_type = 'application/json' # str | Content type. (default to 'application/json')
client_request_id = 'client_request_id_example' # str | 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' # str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # int | 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 = openapi_client.CardInfoLookupRequest() # CardInfoLookupRequest | Accepted request type: CardInfoLookupRequest.
message_signature = 'message_signature_example' # str | 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 = 'region_example' # str | 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)

try:
    # Card information lookup.
    api_response = api_instance.card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, message_signature=message_signature, region=region)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InformationLookupApi->card_info_lookup: %s\n" % e)

Parameters

Name Type Description Notes
content_type str Content type. [default to 'application/json']
client_request_id str 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 str Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp int 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 str 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 str 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

HTTP response details

Status code Description Response headers
200 Success response. -
400 The request cannot be validated. -
403 The request was unauthorized. -
404 The requested resource doesn't exist. -
500 An unexpected internal server error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

lookup_account

CardInfoLookupResponse lookup_account(content_type, client_request_id, api_key, timestamp, account_info_lookup_request, message_signature=message_signature, region=region)

Account information lookup.

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

Example

from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.InformationLookupApi()
content_type = 'application/json' # str | Content type. (default to 'application/json')
client_request_id = 'client_request_id_example' # str | 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' # str | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # int | 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 = openapi_client.AccountInfoLookupRequest() # AccountInfoLookupRequest | Accepted request type: PaymentCardInfoLookupRequest and PaymentTokenInfoLookupRequest
message_signature = 'message_signature_example' # str | 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 = 'region_example' # str | 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)

try:
    # Account information lookup.
    api_response = api_instance.lookup_account(content_type, client_request_id, api_key, timestamp, account_info_lookup_request, message_signature=message_signature, region=region)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InformationLookupApi->lookup_account: %s\n" % e)

Parameters

Name Type Description Notes
content_type str Content type. [default to 'application/json']
client_request_id str 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 str Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp int 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 str 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 str 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

HTTP response details

Status code Description Response headers
200 Success response. -
400 The request cannot be validated. -
403 The request was unauthorized. -
404 The requested resource doesn't exist. -
500 An unexpected internal server error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]