Appearance
Introduction
Card Acquiring consists of capturing funds from a third-party card to credit a Treezor Wallet.
Treezor relies on HiPay as a payment service provider (PSP) for card acquiring. It is compatible with various payment products such as CB, Visa, and Mastercard.
Feature activation – Acquiring is not enabled by default
Please contact Treezor to get your HiPay credentials and to activate your payment products.
Treezor supports two versions of Acquiring. While this documentation mainly focuses on the newest version, you may find information specific to the Legacy in the corresponding Legacy flow article.
Use cases
The Card Acquiring feature can be used in the following use cases.
| Use case | Description |
|---|---|
| Top-up | The end user credits their Treezor Wallet by using their external account payment card. In such cases, the end user may credit their wallet either:
|
| Complement | When the end user doesn't have enough funds on their Treezor Wallet to make the payment, they may complement the payment with funds captured on their external account payment card. This use case requires the "recurring" mode. |
HiPay Credentials
HiPay provides 2 environments: Staging (Sandbox) and Production. Each environment has its own set of credentials that Treezor provides to you. Your public credentials are to be base64-encoded before being used in the Authorization header of your requests (basic access authentication).
You may replace the values in the code snippets of this documentation as follows:
| Value | URLs |
|---|---|
{hiPayBaseUrl} | Staging: https://stage-secure-gateway.hipay-tpp.com/Production: https://secure-gateway.hipay-tpp.com/ |
{hiPayTokenizationFormBaseUrl} | Staging: https://stage-api.hipay.com/ Production: https://api.hipay.com/ |
{hiPayTokenizationBaseUrl} | Staging: https://stage-secure2-vault.hipay-tpp.com/Production: https://secure2-vault.hipay-tpp.com/ |
HiPay also provides 2 dashboards:
- Staging: https://stage-console.hipay.com
- Production: https://console.hipay.com
Payment products specificities
Below are the specificities of each payment product.
paymentProduct | Mandatory attributes | End user forwarding | Advanced capture | Refunds |
|---|---|---|---|---|
mastercard | topupCardId |  |  | |
visa | topupCardId | | | |
cb | topupCardId | | | |
maestro | topupCardId | | | |
bcmc | topupCardId | | | |
sofort-uberweisung | ∅ | To forwardUrl | | |
ideal | issuerBankId | To forwardUrl | | |
Endpoints
| Endpoint | Scope |
|---|---|
/v1/topups/cards/users/{userId}/topupCards Associate a tokenized topup card to a user | read_write |
/v1/topups/cards/users/{userId}/topupCards Search topup cards for a given user | read_only |
/v1/topups/cards/users/{userId}/topupCards/{topupCardId} Retrieve information about a topup card | read_only |
/v1/topups/cards/users/{userId}/topupCards/{topupCardId} Cancel a topup card | read_write |
/v1/topups/cards/authorizations Create a card topup authorization | read_write |
/v1/topups/cards/authorizations/{authorizationId} Retrieve a card topup authorization | read_only |
/v1/topups/cards/authorizations/{authorizationId} Delete a card topup authorization | read_write |
/v1/topups/cards/authorizations/{authorizationId}/payins Create payin from an authorization | read_write |
/v1/topups/cards/authorizations/{authorizationId}/payins List all payins from an authorization | read_only |
/v1/topups/cards/refunds/{refundId} Retrieve a card topup payin refund | read_only |
/v1/topups/cards/refunds Create a card topup payin refund | read_write |
/v1/topups/cards/chargebacks/{chargebackId} Retrieve a card topup payin chargeback | read_only |
Reading – Learn more about Acquiring