Find card

This method allows partners to obtain a unique card_id using alternative attributes associated with a card.
It is intended for scenarios where a direct card identifier is not available, but other identification parameters - such as a masked card data, or an encrypted card number (PAN) - can be used to locate the card in the system.

The method accepts a flexible set of search parameters, enabling partners to query the card using different attribute types.
When multiple parameters are provided, the system attempts to find a card that matches all specified criteria.

To obtain a card identifier using the PAN, partners may pass the PAN value in encrypted form.
The PAN must be encrypted using the RSA algorithm with OAEP padding and the public RSA key provided by Freedom Pay.
The OAEP digest algorithm must be SHA-256.

Encryption requirements:

Encrypt the original PAN using RSA-OAEP with SHA-256.

Encode the encrypted result using Base64.

Pass the resulting value as the card_pan search parameter in the request.

This approach ensures secure transmission of sensitive card data while allowing the system to identify the corresponding card and return its unique card_id.

application/json

Body

Example

{
    "status": "ok",
    "request_status": "success",
    "dt": "2025-01-01T00:01:01+00:30",
    "cards": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

Request

Responses