API Documentation

Introduction

In this manual we will take you through a few simple steps to integrate our API in your webshop. This will enable your customers to choose from our vast range of digital goods in your webshop environment. Whether it is e-gift cards, game keys, phone credit or prepaid payment cards - your customer chooses, our API delivers and your webshop converts - directly from our stock!

Ready to make this happen? Let's go!

Setting Up

Let's start with the configurations on your platform. First: Create an account on https://app.prepaidforge.com to follow the next steps.

Test it in Sandbox Mode (optional)

This step is optional, but enables you to safely test our API in Sandbox Mode. This way you can try out making orders and API calls without any risk. You will receive test codes to try out all functionality before you go live and order real codes.

You can find the Toggle Sandbox option in your Settings, in the tab API. When you have tested everything to your satisfaction, simply disable the Sandbox Mode and you are live!

Top up your account balance

Before we can start, you need to deposit some credit on your account. That is necessary to enable automatic delivery of the codes, which will be paid for by your account balance.

Go to the Balance page and request a Deposit. Then, find your invoice in the transaction list and issue a payment. In Sandbox Mode, invoices are automatically approved.

Enable Server IP

Add your IP-address to your settings in the API tab. Give your server a name so you know which IP belongs to what server. Request an approval of your server. After we have approved it, you are ready to go!

Authentication

To find your prices and create orders, you need an API Token. This is an expiring code, so you need to recreate this token after it has expired.

// Request
{
  "email":"YourEmail@PrepaidForge.com",
  "password":"YourPassword123!"
}

// Response
{
  "apiToken": "YOUR API TOKEN",
  "tokenValidUntil": 1509722838615
}

Products

You can find all our products with one API call.

[
  {
    "sku": "Netflix-25-EUR",
    "name": "Netflix 25 EUR",
    "gtin": "5051644047703",
    "brand": "Netflix",
    "faceValue": {
      "amount": 0,
      "currency": "EUR",
      "formattedString": "€0,0000"
    },
    "currencyCode": "EUR",
    "isCurrencyProduct": true,
    "imageUrl": "//cdn.prepaidforge.com/productimages/netflix2.png",
    "active": true,
    "countries": ["be", "de"],
    "categories": ["Giftcards"]
  },
  ...
]

// Request
{
  "page": 369,
  "pageSize": 10
}

Find your product online

Alternatively, you can look up all our products online in the WebApp! Every product has an API Identifier that you can use to order the product in our API.

Stock

We have different stock options for (most of) our products. Each stock option has a different pricing, depending on the type of code (e.g. text or scan) and available quantity.

Quantity Explained: If you see a positive number, that is the amount we have. If quantity is -1, stock is undefined and you can just order. Only if quantity is 0, it is sold out.

// Request
{
  "types":["TEXT", "SCAN"],
  "skus":["Netflix-25-Eur"]
}

// Response
[
  {
    "product": "Netflix-25-EUR",
    "type": "SCAN",
    "quantity": 286,
    "purchasePrice": 25.14
  },
  {
    "product": "Netflix-25-EUR",
    "type": "TEXT",
    "quantity": -1,
    "purchasePrice": 27.24
  }
]

Orders

If you are ready to order a code, simply provide the price, code type and product identifier in your order call. You can optionally include a customOrderReference.

// Request
{
  "sku": "Netflix-25-EUR",
  "price": 25.14,
  "codeType": "SCAN",
  "customOrderReference": "myOwnReference-00001"
}

// Response
{
  "orderReference": "PF-ORDER00000000000001",
  "customOrderReference": "myOwnReference-00001",
  "code": null,
  "serial": "21512521352161253214885",
  "image": {
    "filename": "PF-ITEM0000000000",
    "filetype": "PNG",
    "downloadLink": "https://api.prepaidforge.com/v1/orderDownload/..."
  },
  "codeType": "SCAN"
}

// Request
{
    "page": 1,
    "startDate": 1571184000000,
    "endDate": 1571616000000
}

// Request
{
  "customOrderReference": "myOwnReference-00001"
}

Account & Invoices

Request your current balance (optional).

// Response
{
  "amount": 643.2795,
  "currency": "EUR",
  "formattedString": "€ 643,2795"
}

// Response
{
  "invoiceType": "EU_VAT_VERIFIED",
  "expiryDate": 1568623066000,
  "subtotal": {
    "amount": 492.0000,
    "currency": "EUR"
  },
  "balanceAfterPayment": {
    "amount": 2399478.2500
  }
}

Support & Legal

If you encounter any issues during the integration process or have any questions about using the PrepaidForge API, our support team is here to help!

How to Reach Us

You can reach out to our dedicated support team by emailing us at support@prepaidforge.com.

What to Include in Your Email

• Your account details (email associated with your account)
• A detailed description of your issue or question
• Any relevant API request/response data, logs, or error messages
• The steps you've already taken to resolve the issue, if applicable

Terms and Conditions

By integrating and using the PrepaidForge API, you agree to our Terms and Conditions. This document details the contractual relationship between you and PrepaidForge.

Privacy Policy

We take data privacy seriously. Our Privacy Policy explains how we collect, use, and protect personal information.