oBucks API documentation

The oBucks card is a closed-loop, digital prepaid card issued by Openbucks Corp. oBucks cards are redeemable in over 1,000+ online games.

There are two methods for resellers to order oBucks cards:

1. 1. Card batches: Ordered via a PDF “Purchase Order” form.
2. 2. API: Using an Openbucks’ RESTful Obucks issue API

Sandbox vs Production

While integrating and testing you will use the Sandbox environment. Your merchant account in the Sandbox environment does not need to be funded, and the cards generated are dummies that cannot be used by customers to pay on Openbucks.

Obtaining sandbox keys

In order to start integrating you the following:

1. 1. Whitelisting: please send us the IP of the server(s) that will make the calls to our API
2. 2. Your sandbox dashboard credentials (provided by your Openbucks account manager)
3. 3. This documentation

Obtaining production keys

Once successfully integrated in Sandbox, ask Openbucks to promote you to production. In order to prevent confusion between Sandbox and Production cards, which would cause serious customer service issues, please request the closing of your Sandbox account before moving to Production, and make sure to store separately (or destroy) all the Sandbox cards you have generated while testing.

Both your Public Key and API Secret Key are different in Production than in Sandbox. To retrieve your Production keys, log into the Production dashboard at https://merchant.openbucks.com. Once logged in, you can find your production keys (Public key + API Secret Key) under Settings > Account Keys and URLs.

Note that you need to fund your merchant account before you can issue Obucks cards using this API. This is done offline by transferring money to Openbucks. For more details, please contact Openbucks finance at purchases@openbucks.com. Once your account is funded, it will be charged each time you issue a card. If it goes under an agreed minimum, you will receive a friendly reminder to reload your account in order to avoid service interruptions.

Check merchant account balance

In Sandbox, you don’t need a prepaid balance in order to issue Obucks cards.

In production, there are two ways you can get your current balance:

1. 1. By capturing it when you get the response from the API
2. 2. By logging into the merchant dashboard at https://merchant.openbucks.com and going to Transactions > Review Balance.

The API is designed to issue one card per API request (not batches). If you’d like to generate a batch of cards, you need to run requests in a loop.

To make an API request make an HTTP POST using the following URLs and keys. All parameters in Requests and Responses are in JSON format.

API URLs and keys

Use the following URLs and keys provided to you by Openbucks:

Request (JSON format):

Response (JSON format):

Request example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
"buyer_email":" homsky@openbucks.com ",
"buyer_id":"0123456789ABCDEFGH",
"buyer_ip":"100.200.100.200",
"buyer_mobile":"",
"card_api_id":"openbuckscard",
"currency":"USD",
"delivery":"Yes",
"denom":"5",
"public_key":"f831c668-9dbf-4a26-8920-02dfdb5408bd",
"requested_on":"2019-02-07T04:10:44-08:00",
"sub_property_id":"",
"sub_property_name":"",
"sub_property_url":"",
"tracking_id":"2019-02-07 04:10:445c5c2044d7184",
"Signature":"6e2b7b0c1ccd6c515efe9ee6d37395228585101e7e29295fc7dcf788221a27ef"
}

Response example:

{
"transaction_id":2157,
"card_number":"3259741400543824",
"pin":"3836",
"denom":"5",
"balance":5,
"currency":"USD",
"discount":"-0.47",
"net_cost":"5.47",
"purchased_by":"0123456789ABCDEFGH",
"delivered_to_email":" homsky@openbucks.com ",
"delivered_to_mobile":"",
"error_code":0,
"error_message":"",
"signature":"b9ab09e975a9e8bd325edfac1d36c6924c1d658d367025eef59b59486d44e937",
"completed_on":"2019-02-07T04:10:45-08:00"
}

 1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
"card_api_id" : "openbuckscard" ,
"card_number" : "4021737940879178" ,
"currency" : "USD" ,
"pin" : "8290" ,
"public_key" : "f831c668-9dbf-4a26-8920-02dfdb5408bd" ,
"requested_on" : "2019-04-23T05:58:32-07:00" ,
"services" : "services" ,
"sub_property_id" : "" ,
"sub_property_name" : "" ,
"sub_property_url" : "" ,
"tracking_id" : "2019-04-23 05:58:325cbf0bf903672" ,
"signature" : "df9c0802e24b9de8cf6243f7e478a2884b500c11e860843e07b191d270122182"
}

1
2
3
4
5
6
7
8

{
"currency" : "USD" ,
"balance" : 10 ,
"error_code" : 0 ,
"error_message" : "" ,
"signature" : "b5df2fcfb7599d60aa9714b063e3e397391f7935492b3128db359161b7d788d1" ,
"completed_on" : "2019-04-23T05:58:33-07:00"
}

function generateSignature($request_params, $secret_key) {
ksort($request_params);
$data = implode(',', array_map(function ($v, $k) { return $k . '=' . $v; },
$request_params, array_keys($request_params))) . "," . $secret_key;
return hash('sha256', $data);
}