BIPS Partner

All requests to BIPS API endpoint listed under Versions, will be returned in the same type of JSON encoded envelope structure.

Add User API

Creating a new user on BIPS with your adduser partner API key is done by sending a request to API endpoint https://bips.me/api/v1/adduser containing the details of the user.

Required Fields

email	Email of the user. If in use on BIPS already, Public ID will be returned in the response.
password	Password of the user.
fullname	Full name of the user.

Required Merchant Fields

companyname	Business name.
website	http://example.com
phone	+1 123 123 1234
address1	123 Main St.
address2	City, Province, Postal Code
country	Country of the merchant
type	1 or 2 (Exchange or Forward)
percentage	If “type” is 2, set how much to forward. BIPS exchanges the remaining.
bitcoinaddress	Bitcoin address for forwarding or to make bitcoin settlement from expired invoices.

Optional Fields

mm	Month of date of birth.
dd	Day of date of birth.
yyyy	Year of date of birth.
nick	Social feature, TBA.
gender	female, male or NotApplicable
mobile	Mobile phone number

Sample PHP Request

$fields = array(
  // User POST fields
  'email' => '[email protected]',
  'password' => '123456789',
  'fullname' => 'John Doe',
  // Merchant POST fields
  'companyname' => 'Bitcoin Incorporated',
  'website' => 'http://example.com',
  'phone' => '+1 123 123 1234',
  'address1' => '123 Main St.',
  'address2' => 'City, Province, Postal Code',
  'country' => 'United States of America',
  'type' => '1',
  'percentage' => '100',
  'bitcoinaddress' => '14RALNXN1v8Voj3wRU2hMCwNd8gfGBbi3f',
  // Optional POST fields
  'mm' => '01',
  'dd' => '01',
  'yyyy' => '1990',
  'nick' => 'johndoe',
  'gender' => 'male', // female, male, NotApplicable
  'mobile' => '12345678'
);
$ch = curl_init();
curl_setopt_array($ch, array(
CURLOPT_URL => 'https://bips.me/api/v1/adduser',
CURLOPT_USERPWD => 'Partner_API_KEY',
CURLOPT_POSTFIELDS => http_build_query($fields),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPAUTH => CURLAUTH_BASIC));
$response = json_decode(curl_exec($ch));
curl_close($ch);

Sample Response Envelope

{
 "status": 'Created',
 "uniqid": 'cXc',
 "invoice": '393f268f77450e87d5ada420923f29ab',
 "export": '393f268f77450e87d5ada420923f29ab'
}

status	On successful the status will always be Created. Otherwise it will contain the error message.
uniqid	The unique public identifier of the user on BIPS, Can also be used for Mobile Checkout, https://bips.me/checkout/mobile/
invoice	Invoice API key for the merchant, used to generate invoices.
export	Export API key, for getting users transactions in CSV, JSON or HTML.

Refer to Requests for usage of “invoice” and “export” parameters.

Buy Order API

Creating a new buy order on BIPS Market with your buyorder partner API key is done by sending a request to API endpoint https://bipsmarket.com/api/v1/buy_order containing the details of the order.

Required Fields

email	Email of the user.
uniqid	Public ID of the user.
amount	Amount with all your fees deducted.
currency	Currency of the amount. See list at https://bipsmarket.com/bitcoin-exchange-rates
bitcoinaddress	Bitcoin receive wallet address of the customer.

Sample Response Envelope

{
 "status": 1,
 "message": 'Success',
 "transfer_id": 123
}

status	On successful the status will always be 1
message	Success
transfer_id	The identifier of the order in BIPS Market system.

Buy Order API Statuses

“status”	“message”
2	Invalid Public ID
3	Invalid email
4	Invalid bitcoin address
5	Invalid currency
6 *	Insufficient funds
7	Failure getting balance

* You will need to fund your provided BIPS Market partner bank information.

Buy Order Create API

Updating a buy order for processing on BIPS Market with your buyorder partner API key is done by sending a request to API endpoint https://bipsmarket.com/api/v1/buy_order_create containing the public id of customer and transfer id of the order.

Required Fields

uniqid	Public ID of the customer.
transfer_id	Transfer ID of the order.
amount	Full amount, no fees deducted.
currency	Currency of the amount. See list at https://bipsmarket.com/bitcoin-exchange-rates

Sample Response Envelope

{
 "status": 1,
 "message": 'Success',
 "amount": 0.04327543,
 "rate": 805.00,
 "transfer_id": 123
}

status	On successful the status will always be 1
message	Success
amount	Bitcoin amount received from buy.
rate	The current market rate used.
transfer_id	The identifier of the order in BIPS Market system.

Buy Order Create API Statuses

“status”	“message”
2	Invalid Public ID
3	Invalid Transfer ID
4	Buy failure
5	Bitcoin send queued
6	In process
7	Processed
8 *	Insufficient funds
9	Invalid currency
10	Invalid full amount
11	Waiting to be processed
12	Failure getting balance

* You will need to fund your provided BIPS Market partner bank information.

This section was last updated on May 19, 2014 and replaces all previous versions of this document.