Merchant's module API

Last updated: August 1st, 2021

Methods

The GPS PAY API services provide only such types of transactions to be implemented for 3rd Party Companies (Merchants) on their Side (Web Site or APP’s) for their customer to running transaction out of BGIpay Web Site System. 3rd Party Companies (Merchants) must Supply the IP addresses from where will send the API Request.
• Service URL:
Development:
https://test.bgpay.me/APIMerchantServices/”servicemethodrequest”
Live:
https://gpspay.io/APIMerchantServices/”servicemethodrequest”

ALL THE CODE EXAMPLES WHERE DOING ON DEVELOPMENT ENVIROMENT!

Useful Tip:

You can use this online HTML entity encoder/decoder to generate your code examples.

Merchant/Verify

This Method is used to Verify the Merchant Account on the Reseller Program.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/verify?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMerchantNIT=19108122&ReqMProgramID=200004 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/verify?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMerchantNIT=19108122&ReqMProgramID=200004' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "MerchantID": 231,
    "CompanyName": "Tecnoready",
    "Email": "inhack20@gmail.com",
    "Telephone": 7862237169,
    "AccountNo": 6058154581825786,
    "Currency": "USD",
    "Balance": 0
}

Merchant/Register

This Method is used to register a new Merchant.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/register?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqPC=89923586&ReqCompanyName=RECARGAS EXPRESS
&ReqAddress=AVENIDA 4 CON CALLE 23 TIENDAS ADESCA&ReqCityID=EL MOJAN&ReqProvinceID=Zulia&ReqZipCode=4044&ReqTelephone=4246080033
&ReqEmail=Alirioxjose@gmail.com&ReqTaxNo=J-413089696&ReqPFirstName=Alirio Jose&ReqPLastName=Guanipa Reinoso&ReqPSIN=19625741 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https:/test.bgpay.me/APIMerchantServices/merchant/register?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqPC=89923586
&ReqCompanyName=RECARGAS%20EXPRESS&ReqAddress=AVENIDA%204%20CON%20CALLE%2023%20TIENDAS%20ADESCA&ReqCityID=EL%20MOJAN&ReqProvinceID=Zulia
&ReqZipCode=4044&ReqTelephone=4246080033&ReqEmail=Alirioxjose@gmail.com&ReqTaxNo=J-413089696&ReqPFirstName=Alirio%20Jose&ReqPLastName=Guanipa%20Reinoso&ReqPSIN=19625741' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "MerchantID": 227,
    "CompanyName": "RECARGAS EXPRESS",
    "Email": "Alirioxjose@gmail.com",
    "Telephone": 4246080033,
    "AccountNo": 6058158684705613,
    "Currency": "USD",
    "Balance": 0
}

Merchant/Transfer

This Method is used to transfer money between Merchants(Agents).

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/transfer?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqEMerchantID=226&ReqRMerchantID=223&ReqAmount=100 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/transfer?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqEMerchantID=226&ReqRMerchantID=223&ReqAmount=100' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "TransferTo": "MDABROAD",
    "DebitedAmount": 100,
    "Fee": 0,
    "AuthNo": "003483"
}

Merchant/RegisterBank

This method is used to register Merchant's Bank Accounts.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/registerbank?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223&
ReqAccountNo=898025896325&ReqHolderName=JUAN PEREZ&ReqBankName=BoFA&ReqTransitNoABA=063000047&SWIFT=047000063 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/registerbank?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223&ReqAccountNo=898025896325&ReqHolderName=JUAN%20PEREZ&
ReqBankName=BoFA&ReqTransitNoABA=063000047&SWIFT=047000063' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0
}

Merchant/BankAccounts

This method is used to request Merchant's Bank Accounts ID.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/bankaccounts?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/bankaccounts?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "Accounts": [
        {
            "BankID": "11",
            "BankName": "BoFA",
            "AccountNo": "****6325",
            "HolderName": "JUAN PEREZ",
            "Status": "ACTIVE"
        }
    ]
}

Merchant/BankTransfer

This method is used to transfer funds from Merchant's Account to US Bank Account.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/banktransfer?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223&
ReqAmount=25&ReqBankID=11&ReqNotes=prueba HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/banktransfer?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223&ReqAmount=25&ReqBankID=11&ReqNotes=prueba' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": "0",
    "DebitedAmount": 28,
    "Fee": 3,
    "Balance": "484.4177",
    "AuthNo": "003725"
}

Merchant/Loadaccount

This method is used to load funds from Merchant's US Bank Account to Merchant's GPS PAY Account (ACH or ZELLE).

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/loadaccount?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223&
ReqAmount=15&ReqBankID=11&ReqReferenceNo=ngrteu125ytr25ty HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/loadaccount?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=223&ReqAmount=15&ReqBankID=11&ReqReferenceNo=ngrteu125ytr25ty' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": "0",
    "CreditedAmount": 14.625,
    "Fee": 0.375,
    "AuthNo": "003743"
}

Merchant/Payroll

This Method is used to pay Merchant's Employees in Batch.

<!HTTP CODE EXAMPLE REQUEST>
POST /APIMerchantServices/merchant/payroll/default.asp HTTP/1.1
Host: test.bgpay.me
Content-Type: application/json
{
    "resid": 154,
    "token": "i0mQHBMqDxa0UNgx",
    "merchant": 226,
    "values": [
    {
        "id": "1522",
        "cardNumber": "6058150548328567",
        "amount": 16.50
    },
    {
        "id": "1534",
        "cardNumber": "6058150529155690",
        "amount": 21.25
    },
    {
        "id": "1524",
        "cardNumber": "6058150534449427",
        "amount": 30.52
    }
    ]
}

<!cURL CODE EXAMPLE REQUEST>
curl --location --request POST 'https://test.bgpay.me/APIMerchantServices/merchant/payroll/default.asp' \
--header 'Content-Type: application/json' \
--data-raw '{
    "resid": 154,
    "token": "i0mQHBMqDxa0UNgx",
    "merchant": 226,
    "values": [
    {
        "id": "1522",
        "cardNumber": "6058150548328567",
        "amount": 16.50
    },
    {
        "id": "1534",
        "cardNumber": "6058150529155690",
        "amount": 21.25
    },
    {
        "id": "1524",
        "cardNumber": "6058150534449427",
        "amount": 30.52
    }
    ]
}'

<!JSON CODE EXAMPLE RESPONSE>
[
{
    "ErrorCode": 0,
    "id": 1522,
    "authNo": "003504"
},
{
    "ErrorCode": 0,
    "id": 1534,
    "authNo": "003505"
},
{
    "ErrorCode": 0,
    "id": 1524,
    "authNo": "003506"
}
]

Merchant/Card_loadcash

This Method is used to load GPS PAY Account with Cash on Merchants.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/card_loadcash?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&
ReqMMerchantID=202&ReqMPassw=855855&ReqCardNumber=6058150541066966&ReqMobileNo=0&ReqAmount=15 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/card_loadcash?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=202&ReqMPassw=855855&ReqCardNumber=6058150541066966&ReqMobileNo=0&ReqAmount=15' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Balance": 5454.5675,
    "authno": 003235
}

Merchant/Card_loadvoucher

This Method is used to load GPS PAY Account with Voucher on Merchants.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/card_loadvoucher?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&
ReqPaymentTypeID=C&ReqVoucherNumber=454430058898&ReqCardNumber=6058150541066966&ReqMobileNo=0 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/card_loadvoucher?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqPaymentTypeID=C&ReqVoucherNumber=454430058898&ReqCardNumber=6058150541066966&ReqMobileNo=0' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "AmountLoad": 23.05,
    "AuthNo": "003475"
}

Merchant/Voucher_gen

This Method is used to sale (generate) a Voucher to Customers.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/voucher_gen?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=202&ReqAmount=15 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/voucher_gen?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=202&ReqAmount=15' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Total": 18.95,
    "VoucherNo": 722661120278,
    "authno": 003230
}

Merchant/Qrcode_purchase

This Method is used to by at Merchants with Customer's QRCode(one Purchase).

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/qrcode_purchase?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&
ReqMMerchantID=202&ReqQRTokenNo=147596087766&ReqStrTotal=15&ReqQRPIN HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
 curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/qrcode_purchase?
 ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=202&ReqQRTokenNo=147596087766&ReqStrTotal=15&ReqQRPIN' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Total": 14.4,
    "Merchant":ventas pc,
    "authno": 003233
}

Merchant/Qrcode_purchase(variable)

This Method is used to by at Merchants with Customer's QRCode(multiple Purchase)

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/qrcode_purchase?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&
ReqMMerchantID=154&ReqQRTokenNo=6058150510510176&ReqStrTotal=20&ReqQRPIN=9072 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/qrcode_purchase?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=154&ReqQRTokenNo=6058150510510176&ReqStrTotal=20&ReqQRPIN=9072' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Total": 19.4,
    "Merchant":ventas pc,
    "authno": 003234
}

Merchant/Report_trans

This method is used to fetch the list of recent last ten Merchant’s transactions.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/report_trans?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=202 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/report_trans?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=202' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "Transacciones": [
        {
            "Fecha/Hora": "6/16/20/16:42:11",
            "TRANSACCION": "Cargar Fondos con Token(voucher) **066966",
            "CANTIDAD": "15",
            "DESCUENTO": "0",
            "DEBITO": 15,
            "CREDITO": 0.39,
            "AUTH NO": 003228
        },
        {
            "Fecha/Hora": "6/16/20/16:39:56",
            "TRANSACCION": "Cargar Fondos con Token(voucher) **066966",
            "CANTIDAD": "15",
            "DESCUENTO": "0",
            "DEBITO": 15,
            "CREDITO": 0,
            "AUTH NO": 003227
        },
        {
            "Fecha/Hora": "6/16/20/12:23:33",
            "TRANSACCION": "Cargar Fondos en una Agencia **066966",
            "CANTIDAD": "15",
            "DESCUENTO": "0",
            "DEBITO": 18.95,
            "CREDITO": 0,
            "AUTH NO": 003222
        },
        {
            "Fecha/Hora": "6/16/20/12:23:33",
            "TRANSACCION": "Cargar Fondos en una Agencia ****6966",
            "CANTIDAD": "15",
            "DESCUENTO": "0",
            "DEBITO": 0,
            "CREDITO": 0.158,
            "AUTH NO": 003222
        },
        {
            "Fecha/Hora": "6/16/20/11:31:37",
            "TRANSACCION": "Cargar Fondos en una Agencia **066966",
            "CANTIDAD": "10",
            "DESCUENTO": "0",
            "DEBITO": 13.95,
            "CREDITO": 0,
            "AUTH NO": 003220
        }
    ]
}

Merchant/Reprint_trans

This Method is used to Request Trans Details at Merchants.

<!HTTP CODE EXAMPLE REQUEST>
GET /APIMerchantServices/merchant/reprint_trans?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&
ReqCardNumber=6058150541066966&ReqAuthNo=003233 HTTP/1.1
Host: test.bgpay.me

<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMerchantServices/merchant/reprint_trans?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCardNumber=6058150541066966&ReqAuthNo=003233' \

<!JSON CODE EXAMPLE RESPONSE>
{
    "Fecha/Hora": "6/17/20 17:59:09",
    "TRANSACCION": "Emision de un QRCode por el Cliente PRUEBA DEL QR***0176",
    "Holder Name": "victor suarez",
    "DEBITO": 101,
    "CREDITO": 0,
    "Saldo": "5439.5675",
    "AUTH NO": 003233
}

Tables

The information about the Parameters in the Methods Request are showing in the Tables below.

Request Parameters

#	Parameter Name	Type	Description
1	ReqMerchantID	Numeric	The “MerchantID” is the primary account identifier.
2	ReqToken	String	The token that is provided by BestGlobalPayments to the merchant for merchant identification.
3	ReqMMerchantID	String	The MerchantID of the Entity receiving Account/Cards payments.
4	ReqCardNumber	String	The Customer's Account/Card Number(only 16 digits).
5	ReqMPassw	String	Merchant’s Account Login Password.
6	ReqMobileNo	String	Customer's cellular phone number (Numbers only).
7	ReqAmount	String	Amount to load account/card.
8	ReqVoucherNumber	String	The voucher that is provided by Customer to the merchant to load Customer's Account.
9	ReqPaymentTypeID	String	The payment method customer will use (C - for CardNumber or P - for Phone Number).
10	ReqQRTokenNo	String	The Number that Merchant read from the Customer's QRCodes (12 or 16 Numbers only).
11	ReqStrTotal	String	Amount to Pay to Merchant from Customer's QRCode.
12	resid	Numeric	The "resid" = “MerchantID” is the primary account identifier.
13	merchant	String	The "merchant" = MerchantID of the Entity who will do the Payroll.
14	id	String	The "id" = CustomerID on the Reseller system who will receive the Payroll.