Our Public API offers a possibility to create and update banking products in your solutions. Your solution can have multiple banking products which can be offered to your users to create accounts.
The API enables you to customise the products you offer by adding a custom name, description and image. It also allows you to manage their availability to users.
Product entity in Toqio should be linked to Partner Product entity in a banking provider integration to enable account creation.
Create Product
This endpoint can be used to create a Product in Toqio.
POST
https://api.sandbox.toq.io/wallet/api/customers/{customerId}/products
Path Params
customerId (Path Variable): The ID of the customer.
Body Params
bankingProvider (string), obligatory: The name of the banking provider which provides the partner product to be related to the product you are creating
partnerProduct(string), obligatory: The code of the partner product to be related to the product you are creating
name(object), obligatory: This represents the name of your product and can be sent in different languages. The name will be displayed on a product card in your solution for the end user.
- String es - represents Spanish translation: not required, but if it is not received and it has a value we will remove the existing value
- String en - represents English translation: not required, but if it is not received and it has a value we will remove the existing value
- String zh -- represents Chinese translation: not required, but if it is not received and it has a value we will remove the existing value
description (object): This allows you to send description text for your product and can be sent in different languages. The description will be displayed on a product card below the name of the product.
- String es - represents Spanish translation: not required, but if it is not received and it has a value we will remove the existing value
- String en - represents English translation: not required, but if it is not received and it has a value we will remove the existing value
- String zh -- represents Chinese translation: not required, but if it is not received and it has a value we will remove the existing value
ledgerTypeId (string), obligatory: This indicates what type of ledger this product is supported by. Please use one of the values:
- regular - for regular accounts supporting payments
- acquiring - for acquiring accounts like PoS and digital cash
- lending - for lending accounts
- insurance - for insurance ledgers
Please ask your Customer Success Manager if unsure what type to use here.
visible (boolean), obligatory: This field if set to false will not show this product to the end users in your solution. Must be false or true, it can not be null.
marketplaceKey (string), obligatory: This is the unique identifier of the app which will have this product included in your solution.
For example, if you would like the product you are creating to be a part of your banking app installed in your web and mobile solution you will need to add the marketplace Key as a unique identifier of that particular banking app.
The marketplaceKey value for an installed app can be found in the app's url slug: /ledger/app-marketplace-key
productImageBase64 (string): This field allows you to add an image to your product as a base64 formatted string. We recommend the image resolution of min 48x48px and the file's size allowed is up to 10MB.
productImageName (string), obligatory only if a product image is being sent: If you are adding a product image you need to make sure to add a value to this field too. This name will be used to identify your image in Toqio and will not be visible to the end user. If used it must include the extension of the file.
Update Product details
This endpoint can be used to update some Product details that can be changed.
PUT
https://core.test.toq.io/wallet/api/customers/LUM/products/{productId}
Path Params
customerId (Path Variable): The ID of the customer.
productId(Path Variable): The ID of the product you would like to update
Body Params
name(object): This represents the name of your product and can be sent in different languages. The name will be displayed on a product card in your solution for the end user. It is not a required field, but if it is not received and it has a value we will remove the existing value.
- String es - represents Spanish translation: not required, but if it is not received and it has a value we will remove the existing value
- String en - represents English translation: not required, but if it is not received and it has a value we will remove the existing value
- String zh -- represents Chinese translation: not required, but if it is not received and it has a value we will remove the existing value
description (object): This allows you to send description text for your product and can be sent in different languages. The description will be displayed on a product card below the name of the product.
It is not a required field, but if it is not received and it has a value we will remove the existing value.
- String es - represents Spanish translation: not required, but if it is not received and it has a value we will remove the existing value
- String en - represents English translation: not required, but if it is not received and it has a value we will remove the existing value
- String zh -- represents Chinese translation: not required, but if it is not received and it has a value we will remove the existing value
visible (boolean), obligatory: This field if set to false will not show this product to the end users in your solution. Must be false or true, it can not be null.
productImageBase64 (string): This field allows you to add an image to your product in a base64 formatted string
productImageName (string), obligatory only if a product image is being sent: If you are adding a product image you need to make sure to add a value to this field too. This name will be used to identify your image in Toqio and will not be visible to the end user. If used it must include the extension of the file.
The information that we receive via these params is going to replace in our database the existing related data for the specified product. That means that if you set the name in English for example as null we will interpret it as a null and that you want to remove that property.
Each time that you change something we will return all the information stored for that product so you can verify the final result.