Management of PowerBoard Tokens
Learn how to manage your PowerBoard Tokens
Management of Network Tokens
Converting Vault Tokens to Network Tokens
In the event that you have an existing Vault Token that you wish to convert to a Network Token, this can be done by using out Create Network Token API. See the below example of this request.
To have the ability to create Network Tokens, you will need to ensure that your PowerBoard account is configured to have Network Tokens enabled. Please refer to the 'How to register to use Network Tokens' portion of this guide to ensure you are correctly registered to use Network Tokens.
API Endpoint | https://api.staging.powerboard.commbank.com.au/v1/vault-tokens/YOUR_VAULT_TOKEN/network-tokens |
---|---|
HTTP Method | POST |
Headers | x-user-secret-key- POWERBOARD_SECRET_KEY - This is your PowerBoard API Secret Key. Content-Type - application/json - Content-Type will always be application/json. |
{
"status": 201,
"error": null,
"resource": {
"type": "network-token",
"data": {
"_id": "68195d504cf60a46b1d45ae8",
"default": true,
"expire_month": "06",
"expire_year": "2028",
"external_id": "ACT26-2uSCuX9ragRImsDw000000000000GB",
"status": "active",
"token": "5186151968680096",
"service_specific_description": null
}
}
}
When a 201 is received this means that the Token has been successfully converted to a Network Token.
You can still continue to use the original 'vault_token' value to process transactions. If you have an active subscription with a vault token and convert the token to a Network Token. The subscription will continue to run as configured and will use the associated Network Token when processing the next scheduled payment.
Bulk Provisioning of Network Tokens
In the event that you as the merchant have a large amount of Vault Tokens that you wish to provision with Network Tokens this is possible by following our Bulk Provisioning process. Please note that currently only 100 tokens can be provisioned at one time so this may need to be broken down into multiple batches.
The process is as follows:
- Reach out to our Tech Care team with your provisioning needs.
- Provide the necessary details for each Vault Token required to be provisioned with a Network Token
- Our Team will work to begin the provisioning process.
Deletion of Network Tokens
In the event that the merchant or a customer wishes to delete a stored card, you as the merchant can utilise our various Delete Vault API's
Deleting the Vault Token
Deleting a Vault Token will you as the merchant to delete the Vault Token and the associated Network Token, this can be done using the following API call:
API Endpoint | https://api.preproduction.powerboard.commbank.com.au/v1/vault/payment_sources/YOUR_VAULT_TOKEN |
---|---|
HTTP Method | DELETE |
Headers | x-user-secret-key- POWERBOARD_SECRET_KEY - This is your PowerBoard API Secret Key. Content-Type - application/json - Content-Type will always be application/json. |
Deleting the Network Token
In the event that you as the merchant wish to delete the Network Token associated with the Vault Token, this can be done using the following API call:
API Endpoint | https://api.preproduction.powerboard.commbank.com.au/v1/vault-tokens/YOUR_VAULT_TOKEN/network-tokens/NETWORK_TOKEN_ID |
---|---|
HTTP Method | DELETE |
Headers | x-user-secret-key- POWERBOARD_SECRET_KEY - This is your PowerBoard API Secret Key. Content-Type - application/json - Content-Type will always be application/json. |
Updated 4 days ago