# Introduction
Card Acquiring is the action of capturing funds from a third party card, to credit a Treezor Wallet.
This feature can be used for payments and TopUps.
All Card Acquiring flows provided by Treezor are processed by HiPay.
# Available flows
- Acquiring V1
- Acquiring V2 beta
Feature activation – Acquiring is not enabled by default
Regardless of the version you wish to use, this feature requires Treezor to provide you with your HiPay credentials. You can request access by contacting Treezor.
# HiPay Credentials V2 V1
HiPay provides two environments: Staging (corresponds to the Sandbox) and Production. Each environment has its own set of credentials that Treezor provides to you.
You can replace the {hipayBaseUrl}
indicated in the code snippets with the following URLs:
- Staging:
https://stage-secure-gateway.hipay-tpp.com/
- Production:
https://secure-gateway.hipay-tpp.com/
And {hiPayTokenizationBaseUrl}
indicated in the code snippets with the following URLs:
- Staging:
https://stage-secure2-vault.hipay-tpp.com/
- Production:
https://secure2-vault.hipay-tpp.com/
They also provide two Dashboards:
- Staging: https://stage-console.hipay.com (opens new window)
- Production: https://console.hipay.com (opens new window)
# Endpoints
Endpoint | Description | Scope |
---|---|---|
/v1/topups/cards/authorizations | Create a card topup authorization V2 | read_write |
/v1/topups/cards/authorizations/{authorizationId} | Retrieve a card topup authorization V2 | read_only |
/v1/topups/cards/authorizations/{authorizationId} | Delete a card topup authorization V2 | read_write |
/v1/topups/cards/authorizations/{authorizationId}/payins | Create payin from an authorization V2 | read_write |
/v1/topups/cards/authorizations/{authorizationId}/payins | List all payins from an authorization V2 | read_only |
/v1/topups/cards/payins/{payinId} | Retrieve a card topup payin V1 V2 | read_only |
/v1/topups/cards/payins | Create a payin V2 | read_write |
/topups/cards/simulation/notification/authorizations | Simulate an HiPay authorization notification V2 | admin |
/topups/cards/simulation/notification/payins | Simulate an HiPay payin notification V2 | admin |
/topups/cards/simulation/notification/refunds | Simulate an HiPay refund notification V2 | admin |
/topups/cards/simulation/notification/chargebacks | Simulate an HiPay chargeback notification V2 | admin |
/v1/topups/cards/refunds/{refundId} | Retrieve a card topup payin refund V2 | read_only |
/v1/topups/cards/refunds | Create a card topup payin refund V2 | read_write |
/v1/topups/cards/chargebacks/{chargebackId} | Retrieve a card topup payin chargeback V2 | read_only |
/v1/topups/cards/users/{userId}/topupCards | Associate a tokenized topup card to a user V2 | read_write |
/v1/topups/cards/users/{userId}/topupCards | Search topup cards for a given user V2 | read_only |
/v1/topups/cards/users/{userId}/topupCards/{topupCardId} | Retrieve information about a topup card V2 | read_only |
/v1/topups/cards/users/{userId}/topupCards/{topupCardId} | Cancel a topup card V2 | read_write |