Create a key
Details
environment
(sandbox or live) is required. The new key will be restricted to this environment. Read more about environments.IP Whitelist
Permissions
Checking and validating
sandbox
: This is a closed environment for integration testing. No traffic or real world transactions will be created if the API key used is set to the sandbox
environment. Provider behaviour is simulated by Hub2. Also, the transfer and collection accounts used for sandbox
transactions will be the sandbox
accounts.live
: NB: Requires GO LIVE and an integration review by Hub2 before traffic can be sent in a live
(real world) environment. This is the real world environment, a key in this environment allows real traffic to be processed and providers will be contacted if the transaction endpoints are called.Permission | Description | |
---|---|---|
Api.transfer_create | Allows the creation of transfers | |
Api.transfer_read | Allows the reading of transfers | |
Api.payment_intent_create | Allows the creation of payment intents | |
Api.payment_intent_read | Allows the reading of payment intents | |
Api.payment_intent_auth_create | Allows the authentication of a payment | |
Api.payment_fees_read | Allows the reading of payment fees | |
Api.payment_create | Allows the creation of a payment in a payment intent | |
Api.provisioning_read | Allows the reading of provisioning requests | |
Api.provisioning_create | Allows the creation of a provisioning request | |
Api.merchant_balance_read | Allows the reading of transfer and collection accounts balance | |
Api.terminal_payment_create | Allows the creation of payments to be made via payment terminal | |
Api.terminal_payment_read | Allows the reading of payments made via payment terminal | |
Api.kyb_read | Allows the reading of kyb / kyb-transaction | |
Api.kyb_update | Allows the update of kyb | |
Api.kyb_delete | Allows the deletion of kyb / kyb-transaction | |
Api.kyb_create | Allows the creation of kyb / kyb-transaction |