Getting Started

Prerequisites

Before getting started with the integration to the Sandbox of the Silverflow platform, you will need an Agent Activation Token. If you do not already have such a token, please get in touch with your Silverflow representative to obtain one. Please contact Silverflow Support via this form or by sending an email to Silverflow Support.

Activate Account

You are now ready to activate your account and enable the agent we created for you. To do so, call the Activate Agent endpoint.

Use the agent activation token in the authorization header using the bearer token scheme. The request to activate should be formatted in alignment with the following HTTP request requirements:

The response to this method will return the API management key. This key creates additional API keys for specific Silverflow API features and endpoint use cases. An example response:

The Activation Token can only be used once, so securely store the details returned in the response.

The API Key created upon agent activation will have all:all permissions and should only be used as an API management key. Ensure that this initial key is the only one with any "apiKeys" permissions, and use this key to create other keys with specific API permissions.

You can also update this key with IP restrictions to further increase security.

Create API Keys

Now that you have received the API management key, the next step is to create one or more API keys for integration, for example, one for merchant onboarding and one for transaction processing. These keys can be used to call endpoints on the Silverflow API.

API keys are created by calling the Create API Key endpoint.

Please have a look at the Authentication section to learn more about using API Keys.

Create Merchants and Acceptors

After creating the necessary API keys, you can start creating merchants and merchant acceptors. A merchant is the legal entity for which the agent will send card transactions, and a merchant acceptor is the technical configuration of the merchant on the card network side containing the network, MID, MCC, etc. For a single merchant, there will typically be one merchant per supported card network. To create a merchant, use the Create Merchant endpoint:

The binKeys will be provided by Silverflow. For the sandbox environment, they should be included in the communication where you also received the activation token.

In the example above, the merchantAcceptorTemplate created a merchant with two acceptors (one per provided binKey) in a single API call. Additional acceptors can be added later using the Create Acceptor endpoint referencing the merchantKey.

For less straightforward merchant configurations, merchant creation can be done in two stages. First, a merchant is created using the Create Merchant endpoint, omitting the merchantAcceptorTemplate. Then, the Create Acceptor endpoint is used in a second step, referencing the merchantKey.

Creating Charges

Once the merchant and its acceptors have been created, they can process transactions. Use the Create Charges endpoint to create such charges on the Silverflow platform. An example request:

There are many charge types that can be submitted, please look at the API reference for details.

To create a charge, use any of the Create Charges endpoints.

Reconciliation

By default, the charges will be processed and submitted automatically. Once a charge has been submitted for clearing, the full reconciliation details of that particular charge will be available.

You can now retrieve these details by calling the Get Reconciliation Details endpoint and including the from and to timestamps as query parameters. An example response: