From 4ed0b83711672bdb903677ca4379961fc603f61a Mon Sep 17 00:00:00 2001 From: carvilFidelAPI Date: Tue, 26 Mar 2024 23:26:04 +0000 Subject: [PATCH 1/3] Remove Reimbursements API docs This product is now deprecated and should be removed. --- select/offers.md | 11 - select/reimbursement.md | 479 ---------------------------------------- select/webhooks.md | 60 +---- stream/webhooks.md | 5 +- 4 files changed, 2 insertions(+), 553 deletions(-) delete mode 100644 select/reimbursement.md diff --git a/select/offers.md b/select/offers.md index 52760fb3..d150e024 100644 --- a/select/offers.md +++ b/select/offers.md @@ -336,10 +336,6 @@ fileName:offer.json "returnPeriod": 15, "schemes": ["amex", "mastercard", "visa"], "startDate": "2020-06-30T00:00:00", - "automatedReimbursement": { - "enabled": true, - "description": "Reimbursement", - }, "supplier": null, "type": { "name": "discount", @@ -550,13 +546,6 @@ fileName:offer.json
Contains an id property, with the unique identifier for the account that supplies the Offer. Also contains a string type property, for the type of account that supplies the Offer. The type can have one of the values "merchant" | "card-linking" | "affiliate". Defaluts to null.
-
-
- automatedReimbursement - object -
-
This object requires an Account with the Reimbursement product enabled. Has an enabled boolean property, showing if the Automated Reimbursement is active or not. If the enabled flag is set to true, any valid transaction with this Offer will automatically reimburse. This object also contains a description, which is sent to the Reimbursement to facilitate tracking. You can read more about Offers with Automated Reimbursement below.
-
type diff --git a/select/reimbursement.md b/select/reimbursement.md deleted file mode 100644 index 99f89db9..00000000 --- a/select/reimbursement.md +++ /dev/null @@ -1,479 +0,0 @@ -# Reimbursement - -Fidel Reimbursement is an add-on product to _Transaction_ tracking capability, that gives developers the ability to reimburse customers faster and more easily than ever before, by pushing cash directly onto linked cards. - -## Availability - -Reimbursement supports both debit and credit cards by Visa and Mastercard in the US or UK. Your account must be set up either in the US or the UK to have access to the Reimbursement product. - -## Activation - -If your account is set up in the US or UK and you are using an older API version (reimbursement requires version 2021-09-28 or later) or haven't agreed to the [Terms & Conditions](https://fidelapi.com/legal) in your region, you will be prompted to go through the Reimbursement product activation. - -![Reimbursement Activation](https://docs.fidel.uk/assets/images/gifs/reimbursement-activation.gif "Reimbursement Activation") - -## Credits - -Before reimbursing cardholders you will need to buy Fidel Credits. To be able to make a reimbursement request you need to have enough credits in your balance to deduct the reimbursement amount. Credits currently support USD or GBP currency denominations only and must be purchased by bank transfer to FIDEL LIMITED’s beneficiary account using your unique reference code in the description. Find yours under the [Credits view in the dashboard](https://dashboard.fidel.uk/account/credits). - -Fidel Credits are non refundable and non transferable. Take into consideration possible bank transfer delays that can take between 2-3 business days. - -![Credits view in the dashboard](https://docs.fidel.uk/assets/images/credits-view.png "Credits view in the dashboard") - -### Balance - -Your credit balance is updated every time you purchase credits or spend by using Reimbursement. When sending a reimbursement request, the amount is immediately deducted from the balance. If the reimbursement goes to `failed` status, the amount is added again to the balance. Read more information on the [credits balance endpoint](https://reference.fidel.uk/reference/get-account-balance). - -### Credits Balance Example - -Balances are denominated in multiple currencies to support other countries in the future. Currently, we support either `USD` or `GBP` and in this example `balances.USD` value is `$1000`. - -```sh -curl -X GET \ - https://api.fidel.uk/v1/accounts/{accountId}/credits/balance \ - -H 'Content-Type: application/json' \ - -H 'Fidel-Key: ' -``` - -```json -fileName:credits-balance.json -{ - "items": [ - { - "accountId": "61741c3-3dc9-45f5-8e7c-db1dd649afab", - "balances": { - "AUD": 0, - "CHF": 0, - "JPY": 0, - "EUR": 0, - "GBP": 0, - "CAD": 0, - "USD": 1000, - "NZD": 0 - }, - "lastTotalAmount": { - "AUD": 0, - "CHF": 0, - "JPY": 0, - "EUR": 0, - "GBP": 0, - "CAD": 0, - "USD": 1000, - "NZD": 0 - }, - "lowCreditsNotificationSent": { - "AUD": false, - "CHF": false, - "JPY": false, - "EUR": false, - "GBP": false, - "CAD": false, - "USD": true, - "NZD": false - } - } - ], - "execution": 135.265058, - "resource": "/v1/accounts/61741c3-3dc9-45f5-8e7c-db1dd649afab/credits/balance", - "status": 200 -} -``` - -

Low Balance Notification

- -When a currency balance drops to _25%_ of the balance amount you had on your last purchase, `lowCreditsNotificationSent` is set to true and the following actions are then triggered: - -- notification email is sent to account users emails; - -- dashboard notification is shown; - -- `credits.balance.low` webhook is sent if you are listening on your end. Read below on how to set it up. - -### Low Balance Webhook - -The `credits.balance.low` webhook notifies on the _[Low Balance Notification](/select/reimbursement/#low-balance-notification)_ event that happens when the credits balance is running low. Use this webhook to automate credit purchases on your end without the risk of service disruption due to insufficient balance. See the example below with the webhook object triggered by the low USD balance: - -```json -fileName:credits-balance.json -{ - "accountId": "61741c3-3dc9-45f5-8e7c-db1dd649afab", - "balances": { - "AUD": 0, - "CHF": 0, - "JPY": 0, - "EUR": 0, - "GBP": 0, - "CAD": 0, - "USD": 1000, - "NZD": 0 - }, - "lastTotalAmount": { - "AUD": 0, - "CHF": 0, - "JPY": 0, - "EUR": 0, - "GBP": 0, - "CAD": 0, - "USD": 1000, - "NZD": 0 - }, - "lowCreditsNotificationSent": { - "AUD": false, - "CHF": false, - "JPY": false, - "EUR": false, - "GBP": false, - "CAD": false, - "USD": true, - "NZD": false - } -} -``` - -### History - -In the Credits dashboard view you have access to your credit purchases in _Purchased credits_ and credit spent in _Reimbursements_. Read more information on the [credits history endpoint](https://reference.fidel.uk/reference/get-credits-history). - -![Credits history](https://docs.fidel.uk/assets/images/gifs/credits-history.gif "Credits history") - -## Eligibility - -The reimbursement request is done towards a cardholder transaction with the parameter `transactionId` and it needs to meet the eligibility criteria. - -A transaction is said to be eligible when it meets the following criteria: - -- Transaction `currency` is `USD` or `GBP`; - -- Transaction `reimbursement` is `undefined` or `reimbursement.status` is `failed`; - -- Transaction `scheme` is `visa` or `mastercard`; - -- Transaction status is `cleared`; - -- Transaction `time` date is newer than 90 days. - -### Finding Eligible Transactions by Card - -Find eligible card transactions with `cardId` for a specific `amount` and `currency`. Optionally pass `brandId` to find transactions in a specific brand. - -Transactions are sorted automatically in descending order by the best available, following the eligibility criteria, giving more emphasis on the transaction time and then amount. Read more information on the [find eligible reimbursement transactions endpoint](https://reference.fidel.uk/reference/get-transactions-for-reimbursement-by-card). - -![Reimbursement by Card](https://docs.fidel.uk/assets/images/gifs/reimburse-card.gif "Reimbursement by Card") - -### Eligible Transactions Example - -Example `amount` set to `5`, `currency` to `USD` and `brandId` to `Star`. - -```sh -curl -X GET \ - GET https://api.fidel.uk/v1/cards/{cardId}/transactions/reimbursement?amount={amount}¤cy={currency}&brandId={brandId} \ - -H 'Content-Type: application/json' \ - -H 'Fidel-Key: ' -``` - -```json -fileName:reimburse-eligible-transactions.json -{ - "count": 2, - "items": [ - { - // For the purpose of this example, only selected properties are shown - "amount": 10, - "currency": "USD", - "card": { - "scheme": "visa", - }, - "id": "cf0a2949-8603-4609-8d29-03b9ae5a446b", - "accountId": "d1bc1828-f904-48a3-8492-12272c81c117", - "programId": "92a10f41-cbe3-423d-a7b3-61ca4ce5e6c6" - }, - { - // For the purpose of this example, only selected properties are shown - "amount": 20, - "currency": "USD", - "card": { - "scheme": "visa", - }, - "id": "53ad6957-3a28-499a-a206-558b89ca0d45", - "accountId": "d1bc1828-f904-48a3-8492-12272c81c117", - "programId": "92a10f41-cbe3-423d-a7b3-61ca4ce5e6c6" - } - ], - "resource": "/v1/cards/bc538b71-31c5-4699-840a-6d4a08693314/transactions/reimbursement", - "status": 200, - "execution": 26.392104 -} -``` - -## Request - -### Creating a request - -After choosing the `transactionId`, the reimbursement `amount` must be equal to or lower than the transaction `amount` and the `currency` is determined by the transaction. Visa cards have a maximum reimbursement amount limit of _USD $250_ or _GBP £250_, depending on the currency. We currently support `USD` or `GBP` currency transactions. Optionally customise the `description` text that will show in the cardholder bank statement. Read more information on the [create reimbursement endpoint](https://reference.fidel.uk/reference/create-reimbursement). - -![Creating a reimbursement](https://docs.fidel.uk/assets/images/gifs/reimbursing.gif "Creating a reimbursement") - -### Reimbursement Example - -Example `amount` set to `2.55` and custom `description` to `Earned Stars`. - -```sh -curl -X POST \ - https://api.fidel.uk/v1/transactions/{transactionId}/reimbursement \ - -H 'Content-Type: application/json' \ - -H 'Fidel-Key: ' \ - -d '{ - "amount": 2.55, - "description": "Earned Stars" - }' -``` - -After the reimbursement request is received by the card scheme, the newly created `id` is returned, representing the unique identifier for that reimbursement request. - -```json -fileName:reimbursement.json -{ - "items": [ - { - "id": "6c01f956-1f0f-413f-a5db-d1fc8a59ef92" - } - ], - "execution": 120.856835, - "resource": "/v1/transactions/489a79b9-92c7-4338-81ef-1529ee7bd130/reimbursement", - "status": 202 -} -``` - -### Lifecycle - -When you request a reimbursement to an eligible cardholder transaction, we send the request to the card scheme in real time. For that reason, there is no way to stop or cancel your request after it has been sent. - -Reimbursement `status` is set to `pending` while waiting for the card scheme to confirm the successful `issued` status, at which point funds normally hit the cardholder’ account. It takes between 48 to 72 hours for the `issued` status to be updated. - -![Reimbursement status](https://docs.fidel.uk/assets/images/reimbursement-transactions.png "Reimbursement status") - -### Status - -The `status` property represents the possible reimbursement statuses: - -- `pending`: scheme is executing request; - -- `issued`: scheme executed request successfully; - -- `failed`: scheme request failed and `error` object is created. Retry is possible. [See error list for more information](/select/reimbursement#errors). - -## Reimbursement by card - -In some cases, you may want to reimburse a card (and not a specific transaction). However, as card networks allow reimbursements only on specific transactions, the reimbursement request needs to be based on a transaction. The `POST https://api.fidel.uk/v1/cards/{cardId}/reimbursement` endpoint helps you to find such a transaction for this case. You can simply define the `cardId`, and Fidel API will search for the most suitable transaction, and apply the reimbursement on that one. - -The request to this endpoint would require an amount and a currency (and also other optional properties): - -```json -fileName: request.json -{ - "amount": 5, - "currency": "USD", - "description": "Earned Stars", //optional - "brandId": "518c746f-fbf4-420a-8d37-c591adc39684" // optional -} -``` - -The endpoint would then respond with the unique identifier for the reimbursement that will be created for the most suitable transaction on the card. - -```json -fileName: response.json -{ - "items": [ - { - "id": "3c0c4ed5-b821-4390-8a9e-e7c140ec8358" - } - ], - "resource": "/v1/cards/bc538b71-31c5-4699-840a-6d4a08693314/reimbursement", - "status": 200, - "execution": 19.980616 -} -``` - -For more info, please visit the [API reference](https://reference.fidel.uk/reference/create-reimbursement-by-card) for this particular endpoint. - -## Automation - -Automate reimbursement requests when creating an Offer by toggling the “enable automatic reimbursements” checkbox. This toggle will be available if the reimbursement product is active and the Offer’s country is either `USA` (United States of America) or `GBR` (United Kingdom). - -![Automatic reimbursement with Offers](https://docs.fidel.uk/assets/images/gifs/offers-automatic-reimbursement.gif "Automatic reimbursement with Offers") - -Reimbursements will be automatically requested whenever a transaction **is both cleared and qualified** for an Offer with `offer.automatedReimbursement.enabled` set to `true`. Optionally, it's also possible to include a Description for the Reimbursement using the `offer.automatedReimbursement.description`. - -Read more information on the Offers product [in the documentation page](/select/offers). - -### Tracking before issuing - -Track if a transaction will get a reimbursement request by checking the transaction’s `offer` object: - -```json -fileName:transaction-with-offer.json -{ - // For the purpose of this example, only selected properties are shown - "amount": 10, - "amount": 10, - "cleared": true, - "currency": "USD", - "datetime": "2021-08-20T11:11:11", - "offer": { - "automatedReimbursement": true, - "id": "7e55eeae-99d6-4daf-b8c4-ac9ca660e964", - "cashback": 20, - "message": [], - "performanceFee": 3.2, - "qualified": false, - "qualificationDate": null - }, -} -``` - -The `offer.automatedReimbursement` states whether a reimbursement request will be attempted for that transaction or not. The reimbursement will have the same amount as the `offer.cashback` property and the same currency as `currency`. Transactions that already have a reimbursement created for them will not have any reimbursements requested automatically. - -### Tracking after issuing - -Automated reimbursement attempts have the same payloads as regular reimbursements. - -```json -fileName:offer-automated-reimbursement.json -{ - "accountId": "61741c3-3dc9-45f5-8e7c-db1dd649afab", - "amount": 2.55, - "created": "2021-09-30T11:11:11.000Z", - "creditsTransactionId": "1250ab5a-0661-4a06-a40c-8514093a9241", - "currency": "USD", - "description": "Earned Stars", - "status": "pending", - "id": "6c01f956-1f0f-413f-a5db-d1fc8a59ef92", - "scheme": "visa", - "updated": "2021-09-30T11:12:11.000Z", - "transactionId": "489a79b9-92c7-4338-81ef-1529ee7bd130", - "programId": "4a9cef62-dc79-4044-b7aa-34425f753830" -} -``` - -### Failed automated reimbursements - -Automated reimbursement requests can fail – e.g.: account does not have enough credits, transient issue or transaction is not reimbursement eligible (see [Eligibility](/select/reimbursement#eligibility) section). In these cases, they can be retried as described in the [Retry](/select/reimbursement#retry) section. - -## Webhook - -When a reimbursement status is updated from `pending` to `issued` or `failed` the webhook named `reimbursement.pending` or `reimbursement.issued` or `reimbursement.failed` is triggered (corresponding to the new status). The webhook will send the full reimbursement object with the updated `status`. See the example below with the update to `reimbursement.issued` webhook: - -```json -fileName:reimbursement.json -{ - "accountId": "61741c3-3dc9-45f5-8e7c-db1dd649afab", - "amount": 2.55, - "created": "2021-09-30T11:11:11.000Z", - "creditsTransactionId": "1250ab5a-0661-4a06-a40c-8514093a9241", - "currency": "USD", - "description": "Earned Stars", - "status": "issued", - "id": "6c01f956-1f0f-413f-a5db-d1fc8a59ef92", - "scheme": "visa", - "updated": "2021-09-30T11:12:11.000Z", - "transactionId": "489a79b9-92c7-4338-81ef-1529ee7bd130", - "programId": "4a9cef62-dc79-4044-b7aa-34425f753830" -} -``` - -## Errors - -The reimbursement request and status update can fail for various reasons. Your application should handle these errors accordingly. - -

Retry

- -Reimbursement requests can be retried via API or dashboard. - -![Retry reimbursement](https://docs.fidel.uk/assets/images/gifs/retry-reimbursement.gif "Retry reimbursement") - -### API Errors - -These errors might be returned in the [request](/select/reimbursement/#request) endpoint. - - - -### API Error Example - -```json -fileName:reimbursement-request.json -{ - "error": { - "code": "reimbursement-amount-greater-original-amount", - "date": "2021-11-11T14:53:18.968Z", - "message": "Reimbursement amount is greater than original transaction amount", - "metadata": {} - }, - "execution": 105.254359, - "resource": "/v1/transactions/489a79b9-92c7-4338-81ef-1529ee7bd130/reimbursement", - "status": 400 -} -``` - -### Status Errors - -These errors might be returned in the reimbursement `status` update to `failed` from the card scheme and sent to the `transaction.reimbursement.status` webhook. - - - -### Status Error Example - -```json -fileName:reimbursement.json -{ - "accountId": "61741c3-3dc9-45f5-8e7c-db1dd649afab", - "amount": 2.55, - "created": "2021-09-30T11:11:11.000Z", - "creditsTransactionId": "1250ab5a-0661-4a06-a40c-8514093a9241", - "error": { - "code": "reimbursement-network-account-not-found", - "message": "Network was unable to find bank account", - "status": 404 - }, - "description": "Earned Stars", - "status": "failed", - "id": "6c01f956-1f0f-413f-a5db-d1fc8a59ef92", - "scheme": "visa", - "updated": "2021-09-30T11:12:11.000Z", - "transactionId": "489a79b9-92c7-4338-81ef-1529ee7bd130" -} -``` - -## API Reference - -If you're looking to find out more about our Reimbursement API and how to use it with your application, please visit the [Fidel API Reference](https://reference.fidel.uk/reference). diff --git a/select/webhooks.md b/select/webhooks.md index 3c902452..afb23788 100755 --- a/select/webhooks.md +++ b/select/webhooks.md @@ -1,6 +1,6 @@ # Webhooks -Fidel API uses [webhooks](https://en.wikipedia.org/wiki/Webhook) to notify your application when relevant events happen in your account across multiple resources, namely with event types such as `brand.consent`, `card.failed`, `card.linked`, `location.status`, `marketplace.offer.live`, `marketplace.offer.updated`, `program.status`, `transaction.auth.qualified`, `transaction.auth`, `transaction.clearing.qualified`, `transaction.clearing`, `transaction.refund.qualified`, `transaction.refund`, `reimbursement.pending`, `reimbursement.issued`, `reimbursement.failed` and `credits.balance.low`. +Fidel API uses [webhooks](https://en.wikipedia.org/wiki/Webhook) to notify your application when relevant events happen in your account across multiple resources, namely with event types such as `brand.consent`, `card.failed`, `card.linked`, `location.status`, `marketplace.offer.live`, `marketplace.offer.updated`, `program.status`, `transaction.auth.qualified`, `transaction.auth`, `transaction.clearing.qualified`, `transaction.clearing`, `transaction.refund.qualified`, `transaction.refund` and `credits.balance.low`. Fidel API will notify your registered webhook URLs as the event happens, via a HTTP POST request with a signature header for verification, which needs to be received and acknowledged in a timely manner. The HTTP request contains the event object as payload. @@ -499,64 +499,6 @@ curl -X POST \ }' ``` -`reimbursement.pending`, `reimbursement.issued`, `reimbursement.failed` events are triggered when a reimbursement changes state. The `reimbursement.pending` when the new state is `pending`, `reimbursement.issued` when a new state is `issued`, and `reimbursement.failed` when a new state is `failed` - -The payload for these events includes the `reimbursement` object with the up-to-date status. Read more about it in the [Reimbursement page](/select/reimbursement/#webhook). - -```json -{ - "amount": 2.55, - "created": "2021-09-30T11:11:11.000Z", - "creditsTransactionId": "1250ab5a-0661-4a06-a40c-8514093a9241", - "currency": "USD", - "description": "Earned Stars", - "status": "issued", - "id": "6c01f956-1f0f-413f-a5db-d1fc8a59ef92", - "updated": "2021-09-30T11:12:11.000Z", - "transactionId": "5ec08ca8-38c6-42e1-9fa5-32c67e4135b2", - "programId": "4a9cef62-dc79-4044-b7aa-34425f753830" -} -``` - -### Credits - -Fidel Credits can be used to reimburse cardholders. Learn more about Fidel Credits on the [Reimbursement page](/select/reimbursement/#credits) A `credits.balance.low` event is sent when a currency's credit balance drops below 25% of the amount at the time of the previous credits purchase. The payload for these events is the following: - -```json -{ - "accountId": "61741c3-3dc9-45f5-8e7c-db1dd649afab", - "balances": { - "AUD": 0, - "CHF": 0, - "JPY": 0, - "EUR": 0, - "GBP": 0, - "CAD": 0, - "USD": 249, - "NZD": 0 - }, - "lastTotalAmount": { - "AUD": 0, - "CHF": 0, - "JPY": 0, - "EUR": 0, - "GBP": 0, - "CAD": 0, - "USD": 1000, - "NZD": 0 - }, - "lowCreditsNotificationSent": { - "AUD": false, - "CHF": false, - "JPY": false, - "EUR": false, - "GBP": false, - "CAD": false, - "USD": true, - "NZD": false - } -} -``` ## Signatures diff --git a/stream/webhooks.md b/stream/webhooks.md index 7b2e69bd..0018df44 100644 --- a/stream/webhooks.md +++ b/stream/webhooks.md @@ -270,7 +270,6 @@ A `transaction.auth` or **authorization transaction event** is triggered when a "merchantDescriptor": "Purchase", "programId": "76b6bd16-f1db-4eef-8636-bf94b2442e40", "programType": "transaction-stream", - "reimbursementEligible": false, "updated": "2022-05-24T14:09:37.321Z", "wallet": null } @@ -323,7 +322,6 @@ A `transaction.clearing` or **clearing transaction event** is triggered when a t "programId": "76b6bd16-f1db-4eef-8636-bf94b2442e40", "programType": "transaction-stream", "refundTransactionId": "ebb29156-d3e6-433e-826e-a03745f50a9f", - "reimbursementEligible": true, "updated": "2022-06-24T14:13:46.757Z", "wallet": null } @@ -375,7 +373,6 @@ A `transaction.refund` or **refund transaction event** is triggered when a trans "originalTransactionId": "42adf0ef-bdde-436e-a035-3ce142b4f167", "programId": "76b6bd16-f1db-4eef-8636-bf94b2442e40", "programType": "transaction-stream", - "reimbursementEligible": true, "updated": "2022-06-07T09:56:24.052Z", "wallet": null } @@ -417,4 +414,4 @@ function isSignatureValid(fidelHeaders, payload, secret, url) { const signature = base64Digest(base64Digest(content)); return fidelHeaders['x-fidel-signature'] === signature; } -``` \ No newline at end of file +``` From b471a69f0076ce0aaf97a9561931eb543ba19673 Mon Sep 17 00:00:00 2001 From: carvilFidelAPI Date: Tue, 26 Mar 2024 23:36:39 +0000 Subject: [PATCH 2/3] Remove references to Expense Management All replaced by Stream. --- select/sdks/android/reference-v2.md | 2 +- select/sdks/ios/reference-v2.md | 2 +- select/sdks/react-native/reference-v2.md | 4 ++-- stream/sdks/android/guide-v2.md | 8 ++++---- stream/sdks/android/reference-v2.md | 14 +++++++------- stream/sdks/ios/guide-v2.md | 10 +++++----- stream/sdks/ios/reference-v2.md | 12 ++++++------ stream/sdks/react-native/guide-v2.md | 8 ++++---- stream/sdks/react-native/reference-v2.md | 12 ++++++------ 9 files changed, 36 insertions(+), 36 deletions(-) diff --git a/select/sdks/android/reference-v2.md b/select/sdks/android/reference-v2.md index 30683763..b8275ffd 100644 --- a/select/sdks/android/reference-v2.md +++ b/select/sdks/android/reference-v2.md @@ -162,7 +162,7 @@ _Not useful for Loyalty/Select Transactions use cases, at the moment._ ### start(context: Context) Starts a card enrollment flow. If you set the `programType` to: -1. `TRANSACTION_STREAM`, a card enrollment flow will be started, for a Transaction Stream program (usually used by Expense Management applications). +1. `TRANSACTION_STREAM`, a card enrollment flow will be started, for a Transaction Stream program (usually used by Stream applications). 2. `TRANSACTION_SELECT`, a regular card enrollment flow will be started, for your Transaction Select program (usually used by Loyalty applications). #### Parameters diff --git a/select/sdks/ios/reference-v2.md b/select/sdks/ios/reference-v2.md index 8c5399be..9dc2329b 100644 --- a/select/sdks/ios/reference-v2.md +++ b/select/sdks/ios/reference-v2.md @@ -163,7 +163,7 @@ _Not useful for Loyalty/Select Transactions use cases, at the moment._ ### start(from:) Starts a card enrollment flow. If you set the `programType` to: -1. `.transactionStream`, a verified card enrollment flow will be started, for a Transaction Stream program (usually used by Expense Management applications). +1. `.transactionStream`, a verified card enrollment flow will be started, for a Transaction Stream program (usually used by Stream applications). 2. `.transactionSelect`, a regular card enrollment flow will be started, for your Select Transactions program (usually used by Loyalty applications). #### Parameters diff --git a/select/sdks/react-native/reference-v2.md b/select/sdks/react-native/reference-v2.md index a472fccb..ff924882 100644 --- a/select/sdks/react-native/reference-v2.md +++ b/select/sdks/react-native/reference-v2.md @@ -275,7 +275,7 @@ This value is used in the consent text when enrolling a card issued in a United Default value: `Fidel.ProgramType.transactionSelect` -It specifies the type of program you want to enroll cards into. It also influences the flow that the SDK will show to cardholders when enrolling cards. The other supported value of this property is `Fidel.ProgramType.transactionStream`, but it is useful only for cards enrolled for Expense Management applications. +It specifies the type of program you want to enroll cards into. It also influences the flow that the SDK will show to cardholders when enrolling cards. The other supported value of this property is `Fidel.ProgramType.transactionStream`, but it is useful only for cards enrolled for Stream applications. > Note: For your Loyalty application, you don't need to set this property as the default value is the correct one, for your use case. @@ -300,7 +300,7 @@ Parameters: ### Fidel.start() Starts a card enrollment flow. If you set the `programType` to: -1. `Fidel.ProgramType.transactionStream`, a verified card enrollment flow will be started, for a Transaction Stream program (usually used by Expense Management applications). +1. `Fidel.ProgramType.transactionStream`, a verified card enrollment flow will be started, for a Transaction Stream program (usually used by Stream applications). 2. `Fidel.ProgramType.transactionSelect`, a regular card enrollment flow will be started, for your Select Transactions program (usually used by Loyalty applications). ### Fidel.verifyCard(params) diff --git a/stream/sdks/android/guide-v2.md b/stream/sdks/android/guide-v2.md index 5b0b5d5c..f6df098f 100644 --- a/stream/sdks/android/guide-v2.md +++ b/stream/sdks/android/guide-v2.md @@ -1,6 +1,6 @@ # A guide for verified card enrollment with the Android SDK -Our SDK is built to also support other use cases (other than Expense Management). Please take the following steps to integrate and configure the SDK for your Expense Management application. +Our SDK is built to also support other use cases (other than Stream). Please take the following steps to integrate and configure the SDK for your Stream application. > Note: All code examples in this guide and other Android SDK pages will be written in Kotlin, but our SDK works well in Java projects as well. @@ -90,7 +90,7 @@ Fidel.programId = "Your-Program-ID" ### 6. Set the program type -For your Expense Management application you'll need to use a Transaction Stream program, so please set: +For your Stream application you'll need to use a Transaction Stream program, so please set: ```kotlin Fidel.programType = ProgramType.TRANSACTION_STREAM @@ -128,7 +128,7 @@ Fidel.privacyPolicyUrl = "https://yourwebsite.com/privacy-policy" ### 8. Set the allowed country(ies) of card issuance -During card enrollment process, the cardholder needs to select the country where the card was issued. Expense Management use cases can be activated only for cards issued in the **United States**, **Canada** and **United Kingdom**. Please configure the SDK with the following allowed countries or a subset of these countries, depending on the countries where your application is available. If the subset contains a single country, the cardholders will not need to pick the country. The country that you set will be the default country of issue for the cards that are enrolled in your program. +During card enrollment process, the cardholder needs to select the country where the card was issued. Stream use cases can be activated only for cards issued in the **United States**, **Canada** and **United Kingdom**. Please configure the SDK with the following allowed countries or a subset of these countries, depending on the countries where your application is available. If the subset contains a single country, the cardholders will not need to pick the country. The country that you set will be the default country of issue for the cards that are enrolled in your program. ```kotlin Fidel.allowedCountries = setOf(Country.CANADA, Country.UNITED_KINGDOM, Country.UNITED_STATES) @@ -136,7 +136,7 @@ Fidel.allowedCountries = setOf(Country.CANADA, Country.UNITED_KINGDOM, Country.U ### 9. Set Visa as the only supported card scheme -For Expense Management applications, for now, only Visa card schemes are supported. Please configure the SDK with the following property: +For Stream applications, for now, only Visa card schemes are supported. Please configure the SDK with the following property: ```kotlin Fidel.supportedCardSchemes = setOf(CardScheme.VISA) diff --git a/stream/sdks/android/reference-v2.md b/stream/sdks/android/reference-v2.md index 462024ee..7dc9cf51 100644 --- a/stream/sdks/android/reference-v2.md +++ b/stream/sdks/android/reference-v2.md @@ -39,7 +39,7 @@ By setting this property we add a link to your Terms & Conditions in the consent ### Optional properties (but we recommend setting them) -The following properties are technically not mandatory to be set. However, in order to make your Expense Management use case work with your Transaction Stream program, please consider setting them correctly. +The following properties are technically not mandatory to be set. However, in order to make your Stream use case work with your Transaction Stream program, please consider setting them correctly. #### programType: ProgramType @@ -47,7 +47,7 @@ Default value: `ProgramType.TRANSACTION_SELECT` It specifies the type of program you want to enroll cards into. The `ProgramType` influences the flow that the SDK will show to cardholders when enrolling cards. -> Note: For your Expense Management application, you need to use a Transaction Stream program, so you need to set this property to `ProgramType.TRANSACTION_STREAM`. +> Note: For your Stream application, you need to use a Transaction Stream program, so you need to set this property to `ProgramType.TRANSACTION_STREAM`. #### supportedCardSchemes @@ -55,7 +55,7 @@ Type: `Set` Default value: `setOf(CardScheme.VISA, CardScheme.MASTERCARD, CardScheme.AMERICAN_EXPRESS)` -> Important: For Expense Management use cases via Transaction Stream programs, only Visa cards are supported. So you need to set this property to `setOf(CardScheme.VISA)`. +> Important: For Stream use cases via Transaction Stream programs, only Visa cards are supported. So you need to set this property to `setOf(CardScheme.VISA)`. Sets a list of supported card schemes. If a card scheme is supported, cardholders will be able to enroll and verify their card. If a card scheme is not in the list, then the cardholders will see an error message while typing or pasting the unsupported card number. @@ -73,7 +73,7 @@ Type: `Set` Default value: `setOf(Country.CANADA, Country.IRELAND, Country.JAPAN, Country.NORWAY, Country.SWEDEN, Country.UNITED_ARAB_EMIRATES, Country.UNITED_KINGDOM, Country.UNITED_STATES)` -> Important: For Expense Management use cases via Transaction Stream programs, please set only a subset of the following countries: `UNITED_KINGDOM`, `UNITED_STATES`, `CANADA`, as these are the only supported countries. +> Important: For Stream use cases via Transaction Stream programs, please set only a subset of the following countries: `UNITED_KINGDOM`, `UNITED_STATES`, `CANADA`, as these are the only supported countries. Sets the list of countries that cardholders can pick to be the card issuing country. When two or more countries are set, cardholders will be able to select the card issuing country with our country selection UI. @@ -87,7 +87,7 @@ Cases: - `CANADA, IRELAND, JAPAN, NORWAY, SWEDEN, UNITED_ARAB_EMIRATES, UNITED_KINGDOM, UNITED_STATES` -> Important: For Expense Management use cases via Transaction Stream programs, only cards issued in `CANADA`, `UNITED_KINGDOM`, `UNITED_STATES` are supported. +> Important: For Stream use cases via Transaction Stream programs, only cards issued in `CANADA`, `UNITED_KINGDOM`, `UNITED_STATES` are supported. #### deleteInstructions: String @@ -99,7 +99,7 @@ This text informs the cardholder how to opt out of transaction monitoring in you Default value: `UNITED_KINGDOM` -> Important: For Expense Management use cases via Transaction Stream programs, please use one of the following cases: `.UNITED_KINGDOM`, `UNITED_STATES`, `CANADA`, as these are the only supported countries. +> Important: For Stream use cases via Transaction Stream programs, please use one of the following cases: `.UNITED_KINGDOM`, `UNITED_STATES`, `CANADA`, as these are the only supported countries. Sets the `Country` that will be selected by default when the user opens the card enrollment screen. If the `defaultSelectedCountry` is not part of the `allowedCountries` list, then the first country in the `allowedCountries` list will be selected. @@ -174,7 +174,7 @@ This value is used in the consent text when enrolling a card issued in a United ### start(context: Context) Starts a card enrollment flow. If you set the `programType` to: -1. `TRANSACTION_STREAM`, a verified card enrollment flow will be started, for your Transaction Stream program (usually used by Expense Management applications). +1. `TRANSACTION_STREAM`, a verified card enrollment flow will be started, for your Transaction Stream program (usually used by Stream applications). 2. `TRANSACTION_SELECT`, a regular card enrollment flow will be started, for your Transaction Select program (usually used by Loyalty applications). #### Parameters diff --git a/stream/sdks/ios/guide-v2.md b/stream/sdks/ios/guide-v2.md index e55a9793..41c37aec 100644 --- a/stream/sdks/ios/guide-v2.md +++ b/stream/sdks/ios/guide-v2.md @@ -1,6 +1,6 @@ # A guide for verified card enrollment with the iOS SDK -Our SDK is built to also support other use cases (other than Expense Management). Please take the following steps to integrate and configure the SDK for your Expense Management application. +Our SDK is built to also support other use cases (other than Stream). Please take the following steps to integrate and configure the SDK for your Stream application. > Note: If an example project helps with your SDK integration & configuration, please check our [GitHub repository](https://github.com/FidelLimited/fidel-ios). @@ -56,7 +56,7 @@ pod install pod update Fidel ``` -> Note: For information about all the Fidel API iOS SDK versions, that were used by expense management applications, please check our Releases page. +> Note: For information about all the Fidel API iOS SDK versions, that were used by Stream applications, please check our Releases page. #### Manual framework integration @@ -108,7 +108,7 @@ Fidel.programID = "Your-Program-ID" ### 6. Set the program type -For your Expense Management application you'll need to use a Transaction Stream program, so please set: +For your Stream application you'll need to use a Transaction Stream program, so please set: ```swift Fidel.programType = .transactionStream @@ -146,7 +146,7 @@ Fidel.privacyPolicyURL = "https://yourwebsite.com/privacy-policy" ### 8. Set the allowed country(ies) of card issuance -During card enrollment process, the cardholder needs to select the country where the card was issued. Expense Management use cases can be activated only for cards issued in the **United States**, **Canada** and **United Kingdom**. Please configure the SDK with the following allowed countries or a subset of these countries, depending on the countries where your application is available. If the subset contains a single country, the cardholders will not need to pick the country. The country that you set will be the default country of issue for the cards that are enrolled in your program. +During card enrollment process, the cardholder needs to select the country where the card was issued. Stream use cases can be activated only for cards issued in the **United States**, **Canada** and **United Kingdom**. Please configure the SDK with the following allowed countries or a subset of these countries, depending on the countries where your application is available. If the subset contains a single country, the cardholders will not need to pick the country. The country that you set will be the default country of issue for the cards that are enrolled in your program. ```swift Fidel.allowedCountries = [.unitedStates, .unitedKingdom, .canada] @@ -154,7 +154,7 @@ Fidel.allowedCountries = [.unitedStates, .unitedKingdom, .canada] ### 9. Set Visa as the only supported card scheme -For Expense Management applications, for now, only Visa card schemes are supported. Please configure the SDK with the following property: +For Stream applications, for now, only Visa card schemes are supported. Please configure the SDK with the following property: ```swift Fidel.supportedCardSchemes = [.visa] diff --git a/stream/sdks/ios/reference-v2.md b/stream/sdks/ios/reference-v2.md index c011fb93..04494658 100644 --- a/stream/sdks/ios/reference-v2.md +++ b/stream/sdks/ios/reference-v2.md @@ -39,7 +39,7 @@ By setting this property we add a link to your Terms & Conditions in the consent ### Optional properties (but we recommend setting them) -The following properties are technically not mandatory to be set. However, in order to make your Expense Management use case work with your Transaction Stream program, please consider setting them correctly. +The following properties are technically not mandatory to be set. However, in order to make your Stream use case work with your Transaction Stream program, please consider setting them correctly. #### programType: ProgramType @@ -47,7 +47,7 @@ Default value: `.transactionSelect` It specifies the type of program you want to enroll cards into. The `ProgramType` influences the flow that the SDK will show to cardholders when enrolling cards. -> Note: For your Expense Management application, you need to use a Transaction Stream program, so you need to set this property to `.transactionStream`. +> Note: For your Stream application, you need to use a Transaction Stream program, so you need to set this property to `.transactionStream`. #### supportedCardSchemes @@ -55,7 +55,7 @@ Type: `Set` Default value: `[.visa, .mastercard, .americanExpress]` -> Important: For Expense Management use cases via Transaction Stream programs, only Visa cards are supported. So you need to set this property to `[.visa]`. +> Important: For Stream use cases via Transaction Stream programs, only Visa cards are supported. So you need to set this property to `[.visa]`. Sets a list of supported card schemes. If a card scheme is supported, cardholders will be able to enroll and verify their card. If a card scheme is not in the list, then the cardholders will see an error message while typing or pasting the unsupported card number. @@ -73,7 +73,7 @@ Type: `Set` Default value: `[.canada, .ireland, .japan, .unitedKingdom, .unitedStates, .sweden, .unitedArabEmirates, .norway]` -> Important: For Expense Management use cases via Transaction Stream programs, please set only a subset of the following countries: `.unitedKingdom`, `.unitedStates`, `.canada`, as these are the only supported countries. +> Important: For Stream use cases via Transaction Stream programs, please set only a subset of the following countries: `.unitedKingdom`, `.unitedStates`, `.canada`, as these are the only supported countries. Sets the list of countries that cardholders can pick to be the card issuing country. When two or more countries are set, cardholders will be able to select the card issuing country with our country selection UI. @@ -99,7 +99,7 @@ This text informs the cardholder how to opt out of transaction monitoring in you Default value: `.unitedKingdom` -> Important: For Expense Management use cases via Transaction Stream programs, please use one of the following cases: `.unitedKingdom`, `.unitedStates`, `.canada`, as these are the only supported countries. +> Important: For Stream use cases via Transaction Stream programs, please use one of the following cases: `.unitedKingdom`, `.unitedStates`, `.canada`, as these are the only supported countries. Sets the `Country` that will be selected by default when the user opens the card enrollment screen. If the `defaultSelectedCountry` is not part of the `allowedCountries` list, then the first country in the `allowedCountries` list will be selected. @@ -176,7 +176,7 @@ This value is used in the consent text when enrolling a card issued in a United ### start(from:) Starts a card enrollment flow. If you set the `programType` to: -1. `.transactionStream`, a verified card enrollment flow will be started, for your Transaction Stream program (usually used by Expense Management applications). +1. `.transactionStream`, a verified card enrollment flow will be started, for your Transaction Stream program (usually used by Stream applications). 2. `.transactionSelect`, a regular card enrollment flow will be started, for your Transaction Select program (usually used by Loyalty applications). #### Parameters diff --git a/stream/sdks/react-native/guide-v2.md b/stream/sdks/react-native/guide-v2.md index 82789cc3..20d2cde7 100644 --- a/stream/sdks/react-native/guide-v2.md +++ b/stream/sdks/react-native/guide-v2.md @@ -1,6 +1,6 @@ # A guide for verified card enrollment with the React Native SDK -Our SDK is built to also support other use cases (other than Expense Management). Please take the following steps to integrate and configure the SDK for your Expense Management application. +Our SDK is built to also support other use cases (other than Stream). Please take the following steps to integrate and configure the SDK for your Stream application. > Note: If an example project helps with your SDK integration & configuration, please check our [GitHub repository](https://github.com/FidelLimited/rn-sdk). @@ -71,7 +71,7 @@ Fidel.setup ({ ### 6. Specify the program type -For your Expense Management application you'll need to use a Transaction Stream program, so please set: +For your Stream application you'll need to use a Transaction Stream program, so please set: ```javascript Fidel.setup ({ @@ -143,7 +143,7 @@ Fidel.setup ({ ### 8. Set the allowed country(ies) of card issuance -During card enrollment process, the cardholder needs to select the country where the card was issued. Expense Management use cases can be activated only for cards issued in the **United States**, **Canada** and **United Kingdom**. Please configure the SDK with the following allowed countries or a subset of these countries, depending on the countries where your application is available. If the subset contains a single country, the cardholders will not need to pick the country. The country that you set will be the default country of issue for the cards that are enrolled in your program. +During card enrollment process, the cardholder needs to select the country where the card was issued. Stream use cases can be activated only for cards issued in the **United States**, **Canada** and **United Kingdom**. Please configure the SDK with the following allowed countries or a subset of these countries, depending on the countries where your application is available. If the subset contains a single country, the cardholders will not need to pick the country. The country that you set will be the default country of issue for the cards that are enrolled in your program. Use the `options` object to set the countries that you support: @@ -166,7 +166,7 @@ Fidel.setup ({ ### 9. Set Visa as the only supported card scheme -For Expense Management applications, for now, only Visa card schemes are supported. Please configure the SDK with the following property: +For Stream applications, for now, only Visa card schemes are supported. Please configure the SDK with the following property: ```javascript Fidel.setup ({ diff --git a/stream/sdks/react-native/reference-v2.md b/stream/sdks/react-native/reference-v2.md index 1c75494a..1cd3586c 100644 --- a/stream/sdks/react-native/reference-v2.md +++ b/stream/sdks/react-native/reference-v2.md @@ -209,7 +209,7 @@ By setting this property we add a link to your Terms & Conditions in the consent ### Optional properties (but we recommend setting them) -The following properties are technically not mandatory to be set. However, in order to make your Expense Management use case work with your Transaction Stream program, please consider setting them correctly. +The following properties are technically not mandatory to be set. However, in order to make your Stream use case work with your Transaction Stream program, please consider setting them correctly. #### programType @@ -217,7 +217,7 @@ Default value: `Fidel.ProgramType.transactionSelect` It specifies the type of program you want to enroll cards into. It also influences the flow that the SDK will show to cardholders when enrolling cards. -> Note: For your Expense Management application, you need to use a Transaction Stream program, so you need to set this property to `Fidel.ProgramType.transactionStream`. +> Note: For your Stream application, you need to use a Transaction Stream program, so you need to set this property to `Fidel.ProgramType.transactionStream`. #### consentText.deleteInstructions @@ -243,7 +243,7 @@ Expected type: `array` Default value: `[Fidel.CardScheme.visa, Fidel.CardScheme.mastercard, Fidel.CardScheme.americanExpress]` -> Important: For Expense Management use cases via Transaction Stream programs, only Visa cards are supported. So you need to set this property to `[Fidel.CardScheme.visa]`. +> Important: For Stream use cases via Transaction Stream programs, only Visa cards are supported. So you need to set this property to `[Fidel.CardScheme.visa]`. Sets a list of supported card schemes. If a card scheme is supported, cardholders will be able to enroll and verify their card. If a card scheme is not in the list, then the cardholders will see an error message while typing or pasting the unsupported card number. @@ -261,7 +261,7 @@ If you set a value with only one country, the country selection UI will not be d If you set an empty value, you will not be able to start the verified enrollment flow. Instead you will receive an error in the main [`callback`](#main-results-callback) (`Fidel.ErrorType.sdkConfigurationError`), immediately after the attempt to start. -> Important: For Expense Management use cases via Transaction Stream programs, please set only a subset of the following countries: `Fidel.Country.unitedKingdom`, `Fidel.Country.unitedStates`, `Fidel.Country.canada`, as these are the only supported countries. +> Important: For Stream use cases via Transaction Stream programs, please set only a subset of the following countries: `Fidel.Country.unitedKingdom`, `Fidel.Country.unitedStates`, `Fidel.Country.canada`, as these are the only supported countries. #### options.defaultSelectedCountry @@ -269,7 +269,7 @@ Default value: `Fidel.Country.unitedKingdom` Sets the `Fidel.Country` that will be selected by default when the user opens the card enrollment screen. If the `defaultSelectedCountry` is not part of the `allowedCountries` list, then the first country in the `allowedCountries` list will be selected. -> Important: For Expense Management use cases via Transaction Stream programs, please use one of the following cases: `Fidel.Country.unitedKingdom`, `Fidel.Country.unitedStates`, `Fidel.Country.canada`, as these are the only supported countries. +> Important: For Stream use cases via Transaction Stream programs, please use one of the following cases: `Fidel.Country.unitedKingdom`, `Fidel.Country.unitedStates`, `Fidel.Country.canada`, as these are the only supported countries. ### Optional properties @@ -353,7 +353,7 @@ Parameters: ### Fidel.start() Starts a card enrollment flow. If you set the `programType` to: -1. `Fidel.ProgramType.transactionStream`, a verified card enrollment flow will be started, for your Transaction Stream program (usually used by Expense Management applications). +1. `Fidel.ProgramType.transactionStream`, a verified card enrollment flow will be started, for your Transaction Stream program (usually used by Stream applications). 2. `Fidel.ProgramType.transactionSelect`, a regular card enrollment flow will be started, for your Transaction Select program (usually used by Loyalty applications). ### Fidel.verifyCard(params) From 477be5b73cc4bbdfdc0aee531e3c8e29db91761c Mon Sep 17 00:00:00 2001 From: carvilFidelAPI Date: Tue, 26 Mar 2024 23:38:32 +0000 Subject: [PATCH 3/3] Remove references to Card Coverage Stream is Visa only, and this diagram is misleading. --- stream/index.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/stream/index.md b/stream/index.md index 8a16a2fd..f90e6037 100644 --- a/stream/index.md +++ b/stream/index.md @@ -37,12 +37,6 @@ Fidel API provides a developer-friendly, secure and reliable API to link payment Once a card is enrolled and verified, every payment event (i.e. authorization, clearing, refund) from that card will be sent to your server in real time. The transaction data you receive is of high quality, accuracy and consistency. This allows you to build a rich experience for cardholders at the moment the transaction is made, while they are still at the terminal or checkout page. -## Card Coverage - -The Transaction Stream API is available for the following card networks and countries: - -Stream Card Coverage - ## Transaction Life Cycle To understand how the Transaction Stream API works and the data it provides to you, it’s important to understand the authorization processes and fund movements that happen when a cardholder makes a purchase.