Skip to content

Create Silverflow API keys

Create the Silverflow API keys Ginger needs to process your payments, with the permissions each key must have.

For acquirers on Silverflow. Ginger calls the Silverflow API on your behalf with API keys that you create in your Silverflow account. You create two keys, one for the Silverflow sandbox and one for production, and share them with Ginger.

Before you begin

  • You have a Silverflow account for the sandbox and for production.
  • You know which features you'll use: 3-D Secure (3DS) by Silverflow and Bancontact need extra permissions.

Create the keys

Create a sandbox key and a production key

Create each key with the Create API key operation of the Silverflow API. Ginger uses the sandbox key for projects in active-testing and the production key for projects in active-production.

Grant the permissions

Grant both keys the same permissions. Don't skip any on the sandbox key: a missing permission usually shows up much later, as a failing payment.

Every key needs these permissions:

"permissions": [
	"cardInfo:GetInfo",
	"charges:Create",
	"charges:Get",
	"charges:List",
	"charges:Refund",
	"charges:CreateMitFunding",
	"charges:CreatePayout",
	"charges:Clear",
	"charges:Reverse",
	"disputes:Get",
	"disputes:List",
	"merchants:Create",
	"merchants:Update",
	"merchants:CreateAcceptor",
	"acceptors:Update",
	"agents:ListBins",
	"agents:GetBin"
]

Ginger uses merchants:Create, merchants:Update, merchants:CreateAcceptor and acceptors:Update for automatic boarding. If you create the merchants and acceptors yourself, ask your Ginger contact whether your keys need them.

If Silverflow runs 3DS for your payments, add:

"permissions": [
	"threeDs:Create",
	"threeDs:Get"
]

If you process Bancontact, add:

"permissions": [
	"bep:All"
]

Check each key

Before you share a key, make a test call with it, for example to list your BINs (agents:ListBins) or to get a charge (charges:Get). This confirms that the key works and has the permissions.

Share the keys with Ginger

For each key, you need the API key ID (it starts with apk-) and the secret. Share them with your Ginger contact over the secure channel they provide.

Keep the secret secret

Never send an API key secret by email or chat, and never send the key ID and the secret together in one message.

Next steps