NorthStarCurrency

Step 1 - Call our Exchange Rate API

End-Point URL : https://northstarcurrency.com/api
Dev API key: sandbox [Please request an API key for Production usage when you are ready]

Please pass in the following API key via the Authorization header apiKey: 12345test

// create the data array
$data = array( "method" => "get_wire_rate", "total" => 100.99, "currency" => "eur" )

// encode the data into JSON
$dataJson = json_encode($data);
// create the CURL post
$ch = curl_init('https://northstarcurrency.com/api/'); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $dataJson); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); curl_setopt($ch, CURLOPT_HTTPHEADER, array( "Content-Type: application/json", "apiKey: 12345test" ));

Variable	Data Type	Example
status	string	"success" or "failed" if status is 'failed', please see 'error' json data
currency	string	USD
total	float (10,2)	99.99
bank_details	string – this string contains all the bank details.	Bank Name: Royal Bank of Canada Bank Address: 20 King St W, Toronto, ON CANADA Bank Account Name: NorthStar Currency Ltd. Bank Account Address: Bank Account Address: 123 Test Ave, Toronto, ON Bank Account: 1234556784321 Bank Swift#: ROYCCAT22
bank_ref	string	Bank Ref#: 3456490146617, FFC NSC
error	string	error string reason(s) of error invalid key invalid currency

Parameter	Data Type	Required	Example
method	string		get_wire_rate
currency	string - 3 chars		cny
total	integer		100.88

Step 2 - Secondary API Call

Make another secondary API call with all the customer information regarding the trade in JSON data format.
For the following currencies, please request the additional data from user: [please see Parameter Chart]

** You MUST authenticate your request by passing in the apikey and your secret key via the Authorization header **

// put all the data into a array string and json encode it


										
$PostToNSData = array("merchantID"=>'tst',

										'student_last_name' => 'lee',

										'student_first_name' => 'vincent',

										'client_email' => 'test@test.com',

										'client_currency_bought' => 'CAD',

										'client_bought_amount' =>'123.10',

										'client_currency_sold' => 'USD',

										'client_sold_amount' => '100.20',

										'status' => 'success',

										'student_id' =>'1234567',

										'invoice_id' => '88888');

// encode the array into JSON Data


											$PostToNSData_string = json_encode($PostToNSData);

// get CURL ready to call API



											$PostToNSApiURL = "https://www.northstarcurrency.com/api/postData.php";  
   
											$ch = curl_init($PostToNSApiURL);     
                                                                 
											curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");

											curl_setopt($ch, CURLOPT_POSTFIELDS, $PostToNSData_string);

											curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

											curl_setopt($ch, CURLOPT_HTTPHEADER, array(

											"Content-Type: application/json",

											"apiKey: 12345test"

											"Content-Length: ".strlen($PostToNSData_string)) // Required for HTTP header the content-length of the incoming 
JSON                                                      
											);

Variable	Required	Example
status	String	'Success' or 'Failed'
northstar_trade_id	Integer A unique ID that is used to identify the transaction in our platform.	8893853
req_doc_msg	String – this string contains a message with a link asking the user to upload required documents to complete the transaction on NorthStar platform. Please present this message to the user on your thank-you page to let the user know additional data is needed to complete the transaction. This variable will only be available for the following currencies: INR & BRL	Additional Document Upload: Please Go to NorthStar BRL Payment Centre - https://www.northstarcurrency.com/brl and enter the following reference: 123TST to complete the transaction.

Variable	Data Type	Required	Example
student_last_name	String		Doe
student_first_name	String		Jane
client_email	String		Jane.doe@test.com
client_currency_bought	String		CAD
client_bought_amount	Float (2 decimal point)		123.10
client_currency_sold	String		USD
client_sold_amount	Float (2 decimal point)		123.10
student_id	Integer		2323232
invoice_id	Integer [A unique ID to identify the transaction within your platform]		1234567
additional_data	String – for the following currencies, please also request the following information from the user in Semi-colon delimited values please. CNY National ID number/passport INR Remitter Name Remitter Street Address Remitter Phone # Remitter PAN # Remitter Bank Name Remitter Bank Account # Souce of Funds Number BRL Sender Name Sender Last Name Sender CPF Number Sender RG Sender City Sender State Address Telephone

Step 3 - Call-Back / Notification URL

Once funds have been sent out from NorthStarCurrency to their respective school our system is capable of sending an update [POST] to a given URL of your choice.

POSTBACK data varies from integration to integration. We will work with you to see what is required.

Variable	Data Type	Example
status	String	'success' or 'failed'
northstar_trade_id	Integer [A unique ID that is used to identify the transaction in our platform that was returned to you in step 2]	12345458

Wire Payment Integration