Skip to content

Latest commit

 

History

History
143 lines (116 loc) · 8.58 KB

CardNetworkLookupServiceService.md

File metadata and controls

143 lines (116 loc) · 8.58 KB

CardNetworkLookupServiceService

A list of all methods in the CardNetworkLookupServiceService service. Click on the method name to view detailed information about that method.

Methods Description
initiate_merchant_query Submit information about a merchant to begin the process of querying the merchant history in the databases of the card networks.<BR>This method validates the data in your request.<BR>This is the first step in the process of querying the card networks about a potential new merchant. When this step is completed successfully, proceed to 'Retrieve Query Results'.
retrieve_query_results Submit information about a merchant to begin the process of querying the merchant history in the databases of the card networks.<BR>This method validates the data in your request.<BR>This is the first step in the process of querying the card networks about a potential new merchant. When this step is completed successfully, proceed to 'Retrieve Query Results'.

initiate_merchant_query

Submit information about a merchant to begin the process of querying the merchant history in the databases of the card networks.<BR>This method validates the data in your request.<BR>This is the first step in the process of querying the card networks about a potential new merchant. When this step is completed successfully, proceed to 'Retrieve Query Results'.

  • HTTP Method: POST
  • Endpoint: /v1/cnl/termination_query

Parameters

Name Type Required Description
request_body CnlTerminationQueryBody ✅ The request body.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_118

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import CnlTerminationQueryBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = CnlTerminationQueryBody(
    partner_merchant_reference="partner_merchant_reference",
    partner_query_reference="partner_query_reference",
    search_criteria={
        "search_area": "global"
    },
    queried_merchant={
        "address": {
            "address_line_1": "address_line_1",
            "address_line_2": "address_line_2",
            "city": "city",
            "country": "country",
            "postal_code": "postal_code"
        },
        "phone_numbers": {},
        "business_category": "Merchant",
        "dba_name": "dba_name",
        "mcc": [
            "5411",
            "5812"
        ],
        "principals": {
            "first_name": "first_name",
            "middle_initial": "middle_initial",
            "last_name": "last_name",
            "email": "email",
            "phone_number": "phone_number",
            "address": {
                "address_line_1": "address_line_1",
                "address_line_2": "address_line_2",
                "city": "city",
                "country": "country",
                "postal_code": "postal_code"
            }
        },
        "is_ecommerce": False,
        "legal_name": "legal_name",
        "url": {},
        "email": "email"
    }
)

result = sdk.card_network_lookup_service.initiate_merchant_query(
    request_body=request_body,
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

retrieve_query_results

Submit information about a merchant to begin the process of querying the merchant history in the databases of the card networks.<BR>This method validates the data in your request.<BR>This is the first step in the process of querying the card networks about a potential new merchant. When this step is completed successfully, proceed to 'Retrieve Query Results'.

  • HTTP Method: GET
  • Endpoint: /v1/cnl/termination_query/{partner_query_reference}

Parameters

Name Type Required Description
partner_query_reference str ✅ Timestamp for the request, in Unix time (seconds).
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_119

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.card_network_lookup_service.retrieve_query_results(
    partner_query_reference="partner_query_reference",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)