API - Application Programming Interface

This document contains description of all functions and specifics concerning API for EstroPay. EstroPay API is programming interface, which will allow you to automate the process of sending payments, receiving information about incoming and outgoing payments, obtaining history of performed transactions or receiving information about EgoPay accounts. API setup is required in order to use EstroPay as a payment processor on your website. Currently EstroPay provides JSON API and SOAP API..

Getting Started

Using EstroPay API you can have fully functional EstroPay Payment wrapper integrated into your website. With this, you can:

Check your wallet balance
Send payments
View payments
History and search for specific payment transactions

Enabling API Access

API setup is required in order to use Estro Pay Ltd as a payment option on your website.

API script can be retrieved after a successful login from your account and then accessing the API tab in your profile.

You will be assigned a merchant code that is basically a key that you will use on your website to access the APIs. You will also have option to select what APIs you will be calling.

Accessing APIs

In order to access EstroPay APIs first you need to get your API Key. APIs are all RESTful APIs. It means that you need to use HTTP methods (GET and POST) to tell API what action you need to perform or what information you need to get.

API Key

In addition you need to provide your API Key in HTTP Header as value of X-API-KEY header variable.

API End Point

Base URL for calling all APIs is same i.e. https://www.estropay.cash/apis/.

Response

All responses are in JSON format by default.

Methods

Following table summarizes the methods available and what is required to call them.

Endpoint https://www.estropay.asia/apis/balance

HTTP Method GET

Params None

Response

HTTP STATUS	JSON Response
On Success:
200 - OK	`{balance: "..."}`

Endpoint https://www.estropay.asia/apis/history

HTTP Method GET

Params None

Response

HTTP STATUS	JSON Response
On Success:
200 - OK	`{transactions: [{…}, {…}, …, {…}]}`

Endpoint https://www.estropay.asia/apis/transaction

HTTP Method GET

Params

transaction_id Transaction ID

Response

HTTP STATUS	JSON Response
On Success:
200 - OK	`{transaction: {…}}`
On Error:
400 - Bad Request	`{'error': "Transaction ID missing"}`
404 - Not Found	`{'transaction': 'Transaction Not Found.'}`

Endpoint https://www.estropay.asia/apis/transfer

HTTP Method POST

Params

`account`	Receiver Account Number
`amount`	Amount to Send
`beneficiary`	Receiver Name - Optional

Response

HTTP STATUS	JSON Response
On Success:
201 - Created	`{'transaction': {…}}`
On Error:
409 - Conflict	`{'error': 'Insufficient amount in your account.'}`
400 - Bad Request	`{'error': 'Amount must be greater than 0.'}`
	`{'error': 'Missing member account number.'}`
404 - Not Found	`{'error': 'No member exist with this account.'}`
500 - Error	`{'error': 'Transaction Failed.'}`

Download API Client

The best and easiest way to call EstroPay APIs is to use the client library which does all the hard work for you.

Click here to download the client library in PHP. It contains all the samples for you to get you started.

SCI - Shopping Cart Interface

This section describes functions and specific details of working with EstroPay Shopping Cart Interface (SCI). SCI is a programmatic interface allowing a merchant to automatically accept online payments. SCI is a must have interface for any online store or business conducting transactions online.

Shop Systems

Shopping cart software modules for online stores offer a quick and easy integration process as well as smooth shopping experience for your customers. EstroPay is compatible with the widest range of commercial and open-source shopping carts giving merchants the ultimate choice to setup their business.

Select a shopping cart in the list below and see how simple it is to add EstroPay payment solution to your preferred provider.

SCI Buttons

EstroPay payment buttons are an easy way to accept payments. To create payment buttons login to your merchant account and go to SCI Integration section. There you can customize your button and create the HTML you'll need to copy and paste into your website.

Forex Integration

This section describes functions and specific details of working with EstroPay Forex Interface. It is a programmatic interface allowing a forex to automatically accept online payments from their customers. It is a must have interface for any online forex conducting transactions online.

EstroPay forex deposit buttons are an easy way to provide deposit facility to your customers. To create deposit buttons login to your merchant account and go to Forex Integration section. There you can customize your button and create the HTML you'll need to copy and paste into your website.