diff --git a/select/cards.md b/select/cards.md index 0ace4fb..b5911b9 100755 --- a/select/cards.md +++ b/select/cards.md @@ -52,7 +52,7 @@ We recommend you use the secure and PCI compliant [SDKs](/select/sdks/web/v3) to All our SDKs require a user to enter their card number and expiry date, along with the country of issue for the card. The SDKs won't require the CVV number, and will not make any active card checks against the cards. The SDKs will pre-populate the `countryCode` and the `programId` of the Program you want to link the card to. The card numbers are tokenised and transmitted directly from our secure pre-built SDKs to our API on submission. This way, your servers are never exposed to sensitive information, removing all PCI compliance requirements for you. -
+
Linking Multiple Cards
To facilitate users linking multiple cards, add identifying key:value pairs from your system in the metadata field. You can read more in the Metadata section below.
@@ -80,7 +80,7 @@ curl -X POST \ }' ``` -
+
Important note
To use the Create Card endpoint, you must use the SDK key. Using the Create Card API endpoint with the Fidel live environment requires your company to be PCI Compliant.
diff --git a/select/getting-started.md b/select/getting-started.md index 37c1b68..e66d9ac 100755 --- a/select/getting-started.md +++ b/select/getting-started.md @@ -49,7 +49,7 @@ To switch between **Live** and **Test** keys, use the **Live Mode toggle** locat 3. Click the **Revoke** button next to it. 4. Confirm the revocation in the dialog by entering your password (for security reasons). -
+
Note: You can have a maximum of two keys per key type (e.g., API and SDK).
To revoke a key, you must have at least one other active key of the same type.
@@ -73,16 +73,16 @@ You can use the web and mobile SDKs to capture your user’s card number and lin Click on the links below to see how to use the web and mobile SDKs in your applications. -
-
- +
+ -
- +
+

Mobile

PCI compliant SDKs for iOS, Android and React Native

diff --git a/select/index.md b/select/index.md index c314477..3caf468 100755 --- a/select/index.md +++ b/select/index.md @@ -1,29 +1,29 @@ -
-
- +
+ -
- +
-
-
- +
+ -
- +
+

SDKs

Take the easy and secure way to add card enrollment capabilities into your application.

@@ -53,7 +53,7 @@ By using Fidel API SDKs, card details are sent directly to Fidel API through a s Your apps will receive an `id` back that identifies the card in each transaction. - @@ -94,7 +94,7 @@ When a cardholder uses a credit or debit card to make a purchase, the funds are
  1. When the cardholder initiates the transaction, their bank (issuing bank, issuer) needs to authorize it. For this, the authorization request must travel from the merchant through the merchant’s bank (acquirer) and through the card network to the issuing bank. -
    +
    2. @@ -102,7 +102,7 @@ When a cardholder uses a credit or debit card to make a purchase, the funds are
  2. If the cardholder has the necessary funds, the issuing bank sends back on the same path the authorization response containing the authorization code (auth code), which means that the cardholder can make the purchase. At this point, the payment amount is still on the cardholder’s account. However, the merchant can safely provide the purchased goods or services, as the transaction was authorized. Usually, the merchant places an authorization hold on the cardholder’s account for the authorized amount of the sale. -
    +
    3. @@ -110,7 +110,7 @@ When a cardholder uses a credit or debit card to make a purchase, the funds are
  3. The next step is the clearing request, which initiates the administrative process of the payment. Typically, clearing occurs at the end of the day, when the acquirer bank collects all the transaction information (amounts, auth codes, etc.) from all payment endpoints of the merchant. Then, on its own processing schedule, the acquirer starts processing the payments with the respective issuing banks. -
    +
    4. @@ -118,7 +118,7 @@ When a cardholder uses a credit or debit card to make a purchase, the funds are
  4. The issuing bank sends back the clearing response, and the funds are moved to the merchant’s account. Note that at Fidel API both cleared and settled transactions are referred to as cleared transactions. -
    +
    5. @@ -132,6 +132,6 @@ When a cardholder links a card to a Fidel API program, Fidel API verifies the ca You can then retrieve the collected data using the Transaction Select API. You can also register webhooks to be notified about the card’s transaction events (new authorization, clearing, etc.). -
    +
    diff --git a/select/locations.md b/select/locations.md index 38487e9..06807c5 100644 --- a/select/locations.md +++ b/select/locations.md @@ -28,7 +28,7 @@ curl -X POST \ The information required for each location is the Brand (with approved consent), address, postcode, city and country. If your location has been assigned Merchant IDs (MIDs) from the card networks, you may add them now. Adding MIDs during Location creation will speed up the onboarding process. -
    +
    Payment Facilitators
    If you need to onboard payment facilitators (Square, iZettle, SumUp, etc.), they may be using shared merchant IDs that have an impact on how transactions are monitored. Reach out to Fidel if you work with merchants that use payment facilitators.
    @@ -39,7 +39,7 @@ Once you have added your locations to Fidel, we can begin the process of Locatio Location status is reported separately for each card scheme. Each location/scheme combination can have one of four statuses: **Idle, Syncing, Active or Not found**. -
    +
    In the test environment, every added Location skips the Location Sync process and is automatically set to Active.
    diff --git a/select/mid-management.md b/select/mid-management.md index 98ca05e..5b7ec7a 100644 --- a/select/mid-management.md +++ b/select/mid-management.md @@ -25,7 +25,7 @@ For more information, see the [Locations/Merchant Onboarding FAQs](https://www.f View and manage Merchant IDs (MIDs) onboarded for your program by selecting a Program from the Programs page. This opens the 'Merchant IDs' tab in the Fidel Dashboard. -Merchant IDs +Merchant IDs All onboarded MIDs for the selected program are displayed on this page. You can also retrieve this information via the API: [Get MID](https://reference.fidel.uk/reference/get-mid#/) | [List MIDs](https://reference.fidel.uk/reference/list-mids#/) @@ -37,7 +37,7 @@ Onboard MIDs to existing locations via the [Create MID Request API](https://refe #### Dashboard Walkthrough -
    +
    Test and Live environments
    It is important to note that when testing Offers with activation in the test environmentm all test transactions created will be visible for testing purposes. In the live environment only Transactions for activated Offers on Cards will be received and qualified.
    @@ -547,7 +547,7 @@ fileName:offer.json status string -
    Offer status corresponding to the state in the Offer Lifecycle. Can be one of requests, upcoming, live or expired.
    +
    Offer status corresponding to the state in the Offer Lifecycle. Can be one of requests, upcoming, live or expired.
    diff --git a/select/sdks/android/guide-v1.md b/select/sdks/android/guide-v1.md index b61c988..f57c1b6 100644 --- a/select/sdks/android/guide-v1.md +++ b/select/sdks/android/guide-v1.md @@ -1,4 +1,4 @@ -# A guide for card enrollment with the Android SDK v1 v2 +# A guide for card enrollment with the Android SDK v1 v2 Please take the following steps to integrate and configure the SDK for your Loyalty use case application. diff --git a/select/sdks/android/guide-v2.md b/select/sdks/android/guide-v2.md index c142948..25e270c 100644 --- a/select/sdks/android/guide-v2.md +++ b/select/sdks/android/guide-v2.md @@ -1,4 +1,4 @@ -# A guide for card enrollment with the Android SDK v1 v2 +# A guide for card enrollment with the Android SDK v1 v2 Please take the following steps to integrate and configure the SDK for your Loyalty use case application. diff --git a/select/sdks/android/reference-v1.md b/select/sdks/android/reference-v1.md index 2fa889f..ff97d81 100644 --- a/select/sdks/android/reference-v1.md +++ b/select/sdks/android/reference-v1.md @@ -1,4 +1,4 @@ -# Android SDK reference v1 v2 +# Android SDK reference v1 v2 1. [Fidel class](#class-fidel) 2. [Properties](#properties) diff --git a/select/sdks/android/reference-v2.md b/select/sdks/android/reference-v2.md index 2d10546..3f95428 100644 --- a/select/sdks/android/reference-v2.md +++ b/select/sdks/android/reference-v2.md @@ -1,4 +1,4 @@ -# Android SDK reference v1 v2 +# Android SDK reference v1 v2 1. [Fidel class](#class-fidel) 2. [Properties](#properties) diff --git a/select/sdks/ios/guide-v1.md b/select/sdks/ios/guide-v1.md index c8f82a3..1fc900d 100644 --- a/select/sdks/ios/guide-v1.md +++ b/select/sdks/ios/guide-v1.md @@ -1,4 +1,4 @@ -# A guide for card enrollment with the iOS SDK v1 v2 +# A guide for card enrollment with the iOS SDK v1 v2 Please take the following steps to integrate and configure the SDK for your Loyalty use case application. diff --git a/select/sdks/ios/guide-v2.md b/select/sdks/ios/guide-v2.md index b14866b..be7fb10 100644 --- a/select/sdks/ios/guide-v2.md +++ b/select/sdks/ios/guide-v2.md @@ -1,4 +1,4 @@ -# A guide for card enrollment with the iOS SDK v1 v2 +# A guide for card enrollment with the iOS SDK v1 v2 Please take the following steps to integrate and configure the SDK for your Loyalty use case application. diff --git a/select/sdks/ios/reference-v1.md b/select/sdks/ios/reference-v1.md index 759d6c1..a9d34a7 100644 --- a/select/sdks/ios/reference-v1.md +++ b/select/sdks/ios/reference-v1.md @@ -1,4 +1,4 @@ -# iOS SDK reference v1 v2 +# iOS SDK reference v1 v2 1. [Fidel class](#class-fidel) 2. [Properties](#properties) diff --git a/select/sdks/ios/reference-v2.md b/select/sdks/ios/reference-v2.md index 9f9fa43..90b7691 100644 --- a/select/sdks/ios/reference-v2.md +++ b/select/sdks/ios/reference-v2.md @@ -1,4 +1,4 @@ -# iOS SDK reference v1 v2 +# iOS SDK reference v1 v2 1. [Fidel class](#class-fidel) 2. [Properties](#properties) diff --git a/select/sdks/react-native/guide-v1.md b/select/sdks/react-native/guide-v1.md index 04e1afb..0b47be6 100644 --- a/select/sdks/react-native/guide-v1.md +++ b/select/sdks/react-native/guide-v1.md @@ -1,4 +1,4 @@ -# A guide for card enrollment with the React Native SDK v1 v2 +# A guide for card enrollment with the React Native SDK v1 v2 Please take the following steps to integrate and configure the SDK for your Loyalty use case application. diff --git a/select/sdks/react-native/guide-v2.md b/select/sdks/react-native/guide-v2.md index eddb5ce..5cf9c02 100644 --- a/select/sdks/react-native/guide-v2.md +++ b/select/sdks/react-native/guide-v2.md @@ -1,4 +1,4 @@ -# A guide for card enrollment with the React Native SDK v1 v2 +# A guide for card enrollment with the React Native SDK v1 v2 Please take the following steps to integrate and configure the SDK for your Loyalty use case application. diff --git a/select/sdks/react-native/reference-v1.md b/select/sdks/react-native/reference-v1.md index 6c89f27..7a02cec 100644 --- a/select/sdks/react-native/reference-v1.md +++ b/select/sdks/react-native/reference-v1.md @@ -1,4 +1,4 @@ -# React Native SDK reference v1 v2 +# React Native SDK reference v1 v2 1. [Fidel class](#class-fidel) 2. [Properties](#properties) diff --git a/select/sdks/react-native/reference-v2.md b/select/sdks/react-native/reference-v2.md index b32e84d..fcd0e37 100644 --- a/select/sdks/react-native/reference-v2.md +++ b/select/sdks/react-native/reference-v2.md @@ -1,4 +1,4 @@ -# React Native SDK reference v1 v2 +# React Native SDK reference v1 v2 1. [Example](#example) with all properties set 2. [Fidel class](#class-fidel) diff --git a/select/sdks/web/v2.md b/select/sdks/web/v2.md index 7165522..f715670 100755 --- a/select/sdks/web/v2.md +++ b/select/sdks/web/v2.md @@ -1,4 +1,4 @@ -# Web SDK v2 v3 +# Web SDK v2 v3 The Fidel SDKs provide a secure way for you to add card-linking capabilities to your applications. The alternative involves using the [Fidel Cards API](https://reference.fidel.uk/reference/create-card), but you'll need to be PCI Compliant before you can use it. Using the Fidel SDKs, card details are sent directly to the Fidel API through a secure connection without exposing your servers to sensitive information. They take care of all PCI Compliance requirements, so you don't have to. diff --git a/select/sdks/web/v3.md b/select/sdks/web/v3.md index 4115bf3..fecd2b0 100755 --- a/select/sdks/web/v3.md +++ b/select/sdks/web/v3.md @@ -1,4 +1,4 @@ -# Web SDK v2 v3 +# Web SDK v2 v3 The Fidel SDKs provide a secure way for you to add card-linking capabilities to your applications. The alternative involves using the [Fidel Cards API](https://reference.fidel.uk/reference/create-card), but you'll need to be PCI Compliant before you can use it. Using the Fidel SDKs, card details are sent directly to the Fidel API through a secure connection without exposing your servers to sensitive information. They take care of all PCI Compliance requirements, so you don't have to. @@ -173,16 +173,7 @@ const label = { onUserCancelledCallback function - Function to be called when the user cancels the card enrollment with one of the following actions: -
    - - Closing the window with the "x" in the top right corner -
    - - Clicking/tapping outside the SDK's frame -
    - - Pressing the ESC key on the keyboard -
    - No arguments are provided. - + Function to be called when the user cancels the card enrollment with one of the following actions:
    - Closing the window with the "x" in the top right corner
    - Clicking/tapping outside the SDK's frame
    - Pressing the ESC key on the keyboard
    No arguments are provided. container @@ -337,11 +328,7 @@ The `custom` property allows for customizing most of the Fidel Web SDK UI. It su close.location - - string
    - Possible values: form | overlay | none
    - Default value: overlay - + string
    Possible values: form | overlay | none
    Default value: overlay The location of the close icon. @@ -351,10 +338,7 @@ The `custom` property allows for customizing most of the Fidel Web SDK UI. It su title.text - - string
    - Default value: "Connect your card" - + string
    Default value: "Connect your card" The text of the title at the top of the page. @@ -394,10 +378,7 @@ The `custom` property allows for customizing most of the Fidel Web SDK UI. It su terms.text - - string
    - Default value: "I authorize {{scheme}} to monitor my payment card to identify transactions that qualify for a reward and for {{scheme}} to share such information with {{companyName}}, to enable my card linked offers and target offers that may be of interest to me." - + string
    Default value: "I authorize {{scheme}} to monitor my payment card to identify transactions that qualify for a reward and for {{scheme}} to share such information with {{companyName}}, to enable my card linked offers and target offers that may be of interest to me." The Terms of Use text. @@ -412,32 +393,22 @@ The `custom` property allows for customizing most of the Fidel Web SDK UI. It su terms.deleteInstructions - - string
    - Default value: "going to your account settings" - + string
    Default value: "going to your account settings" Text to inform the user about how to opt out from the transaction monitoring. It is appended to the text "You may opt out of transaction monitoring on the payment card you entered at any time by". terms.style - - CSS properties
    - + CSS properties
    The styles of the terms text. terms.urlStyle - - CSS properties
    - + CSS properties
    The styles of the URLs (anchor elements) included within the terms text. terms.checkbox - - style: CSS properties
    - checkedStyle: CSS properties - + style: CSS properties
    checkedStyle: CSS properties The styles of the terms checkbox. @@ -447,16 +418,7 @@ The `custom` property allows for customizing most of the Fidel Web SDK UI. It su submit - - style: CSS properties
    - hoverStyle: CSS properties
    - loadingStyle: CSS properties
    - successStyle: CSS properties
    - defaultText: string
    - Default value: "Continue"
    - loadingText: string
    - successText: string - + style: CSS properties
    hoverStyle: CSS properties
    loadingStyle: CSS properties
    successStyle: CSS properties
    defaultText: string
    Default value: "Continue"
    loadingText: string
    successText: string diff --git a/select/transactions.md b/select/transactions.md index 2fdfbd6..99fb4b5 100755 --- a/select/transactions.md +++ b/select/transactions.md @@ -148,7 +148,7 @@ The original transaction has a `refundTransactionId` property set to the `transa If you need the updated information about the original transaction, you can retrieve it using the [Get Transaction endpoint](https://reference.fidel.uk/reference/get-transaction), with the originalTransactionId from the refunded transaction object. -
    +
    Void Transactions
    Voids are treated as refunds. So they will be processed as a refund transaction and trigger the transaction.refund webhook