Customer's module API

Last updated: August 1st, 2020

Service 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/APIServices/”servicemethodrequest”
Live:
https://gpspay.io/APIServices/”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.

Customer/Register
This Method is used to register the new customer. 
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/register?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqFirstName=juan&ReqLastName=garcia&
ReqMobileNo=7862050604&ReqEmail=mibasusa@gmail.com&ReqCountryID=VEN&ReqSINTypeID=DN&ReqSIN=852147654 HTTP/1.1
Host: test.bgpay.me
Content-Type: application/x-www-form-urlencoded
                                                                                        
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/customer/register?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqFirstName=juan&ReqLastName=garcia&ReqMobileNo=7862050604&ReqEmail=mibasusa@gmail.com&
ReqCountryID=VEN&ReqSINTypeID=DN&ReqSIN=852147654' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "CHolderID": 226,
    "CardNo": 6058150592697297,
    "UserID": bgp7297,
    "Password": 7558,
    "Authno": 003144
}
Customer/gpskyc
This method is used to sned customers to the verification system.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/gpskyc/?ReqMerchantID=230&ReqToken=0p3v4eTrZovawOKF&ReqCHolderID=449 HTTP/1.1
Host: test.bgpay.me                                 
                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/customer/gpskyc/?ReqMerchantID=230&ReqToken=0p3v4eTrZovawOKF&ReqCHolderID=449' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "url": "https://signup.getmati.com/?merchantToken=6062092e670d75001bde383e&flowId=6062092e670d75001bde383d&metadata=%7B%22CHolderID%22%3A449%2C%22fixedLanguage%22%3A%22es%22%7D"
}
Customer/Login
This method is used to customer's login to the system.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/login?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&
ReqUserID=bgp7033&ReqPassword=2222 HTTP/1.1
Host: test.bgpay.me                                      
                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/customer/login?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqUserID=bgp7033&ReqPassword=2222' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "CHolderID": 184,
    "UserName":Miguel Perez,
    "CardNo": 6058150547567033,
    "Currency":USD,
    "Balance": 0
}
Customer/Verify
This method is used to verify if a Customer is already register under the Merchant Program .
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/verify?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqSIN=19510067&ReqProgramID=200004 HTTP/1.1
Host: test.bgpay.me                                     
                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/customer/verify?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqSIN=19510067&ReqProgramID=200004' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "CHolderID": 8276,
    "UserID":bgp8276,
    "Password": 1626,
    "CardNo": 6058150556832255,
    "Currency":USD,
    "Balance": 0
}
Customer/Status
This method is used to verify Merchant Customer's Status .
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/status?ReqMerchantID=231&ReqToken=Tzniizri8t0AGUQV&ReqCHolderID=338 HTTP/1.1
Host: test.bgpay.me                                     
                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/customer/status?
ReqMerchantID=231&ReqToken=Tzniizri8t0AGUQV&ReqCHolderID=338' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "UserName": "Lhogan Ortiz",
    "Status":Pre-Aprobado
}
Card/Balance
This method is used to fetch the account/card balance of the customer.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/balance?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=226&ReqPassword=7558 HTTP/1.1
Host: test.bgpay.me
                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/balance?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=226&ReqPassword=7558'
                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "Balance": 0.00
}
Card/fxrates
This method is used to get the exchange Countries Rate.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/fxrates/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqcountryID=VEN HTTP/1.1
Host: test.bgpay.me
                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/fxrates/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqcountryID=VEN' \
                              
                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Rate": "36.11"
}
Card/Loadbk
This method is used to load the customer account/card from domestic bank account.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/loadbk?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=226&
ReqPassword=0408&ReqBankID=TRU&ReqSender=Pedro%20Perez&ReqAmount=15&ReqReferenceNo=258963 HTTP/1.1
Host: test.bgpay.me
                                                                                    
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/loadbk?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=226&ReqPassword=0408&ReqBankID=TRU&ReqSender=Pedro%20Perez&ReqAmount=15&ReqReferenceNo=258963' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "AuthNo": 003146
}
Card/LoadPaysafe
This method is used to request a Bar Code from PaySafeCash Network.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/loadPaysafe?ReqMerchantID=231&ReqToken=Tzniizri8t0AGUQV&ReqCHolderID=338&ReqAmount=30 HTTP/1.1
Host: test.bgpay.me

                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/loadPaysafe?
ReqMerchantID=231&ReqToken=Tzniizri8t0AGUQV&ReqCHolderID=338&ReqAmount=30' \

                                    
<!HTML CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "CHolderID": "369",
    "Token": "1dd7adf4-2409-11ee-be56-0242ac120002"
}
Card/ReqPaysafe
This method is used to request load GPS Account from PaySafeCash Network.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIService/card/reqPaysafe?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=369&ReqAmount=25&ReqPayToken=1dd7adf4-2409-11ee-be56-0242ac120002 HTTP/1.1
Host: test.bgpay.me

                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIService/card/reqPaysafe?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=369&ReqAmount=25
&ReqPayToken=1dd7adf4-2409-11ee-be56-0242ac120002' \

                                    
<!HTML CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "AuthNo": "004602"
}
Card/GPS Add Accounts
This method is used to Add the GPS PAY Accounts to the customer's profile.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIMobile/card/GpsAddAccounts?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=369
&ReqUserID=bgp367&ReqFirstName=Lhogan Jose&ReqLastName=Ortiz  Del Cid HTTP/1.1
Host: test.bgpay.me
                                                                                       
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIMobile/card/GpsAddAccounts?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx
&ReqCHolderID=369&ReqUserID=bgp367&ReqFirstName=Lhogan%20Jose&ReqLastName=Ortiz%20%20Del%20Cid' \
                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0
}
Card/GPS Accounts
This method is used to GET the GPS PAY Accounts registered by the customer in his profile.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/bgpaccounts?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155 HTTP/1.1
Host: test.bgpay.me
                                                                                       
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/bgpaccounts?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "Accounts": [
        {
            "AccountNo": "****3038",
            "HolderName": "FRANCIA MARCANO"
        },
        {
            "AccountNo": "****6871",
            "HolderName": "jorge romero"
        },
        {
            "AccountNo": "****8502",
            "HolderName": "Mauricio Perez"
        }
    ]
}
Card/Transfer
This method is used to transfer funds from one account/card to another account/card.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/transfer?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&
ReqPassword=0408&ReqStrTotal=12&ReqCardNumberTo=6058150592697297&Notes=prueba HTTP/1.1
Host: test.bgpay.me
                                                                                       
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/transfer?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&ReqStrTotal=12&ReqCardNumberTo=6058150592697297&Notes=prueba' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "TransferTo":pepe,
    "DebitedAmount": 11.95,
    "AuthNo": 003147
}
Card/TransferInt
This method is used to transfer funds from one account/card to international account/card.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/transferint?ReqMerchantID=231&ReqToken=Tzniizri8t0AGUQV&ReqCHolderID=338&ReqPassword=8103&ReqStrTotal=15&
ReqCardNumberTo=6058150541066966&Notes=prueba HTTP/1.1
Host: test.bgpay.me
                                                                                       
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/transferint?
ReqMerchantID=231&ReqToken=Tzniizri8t0AGUQV&ReqCHolderID=338&ReqPassword=8103&ReqStrTotal=15&ReqCardNumberTo=6058150541066966&Notes=prueba' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "TransferTo": "****6966",
    "DebitedAmount": 15,
    "Fee": 12,
    "Rate": "7.87",
    "TransferAmount": "118.05"
    "AuthNo": "003882"
}
Card/RegisterBank
This method is used to register Customer's Bank Accounts.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/registerbank?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqBankName=CHASE
&ReqHolderName=Pedro Perez&ReqAccountNo=6897458962&ReqTransitNoABA=063000047&ReqPhoneNo=0&ReqEmail=pepe@gmail.com&ReqCountryID=USA HTTP/1.1
Host: test.bgpay.me
                                                                                       
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/registerbank?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqBankName=CHASE&ReqHolderName=Pedro%20Perez
&ReqAccountNo=6897458962&ReqTransitNoABA=063000047&ReqPhoneNo=0&ReqEmail=pepe@gmail.com&ReqCountryID=USA' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0
}
Card/BankAccounts
This method is used to request Customer's Bank Accounts ID.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/bankaccounts?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155 HTTP/1.1
Host: test.bgpay.me
                                                                                       
                                        
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/bankaccounts?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "Accounts": [
        {
            "BankID": "1003",
            "BankName": "BANK OF AMERICA",
            "AccountNo": " - **** 9898"
        },
        {
            "BankID": "1006",
            "BankName": "WELL FARGO",
            "AccountNo": " - **** 8698"
        },
        {
            "BankID": "1007",
            "BankName": "SUNTRUST",
            "AccountNo": " - **** 8974"
        }
    ]
}
Card/BankTransfer
This method is used to transfer funds from customers's account/card to US Bank account.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/banktransfer?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&
ReqAmount=10&ReqBankID=1003&ReqNotes=prueba HTTP/1.1
Host: test.bgpay.me
                                                                                   
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/banktransfer?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&ReqAmount=10&ReqBankID=1003&ReqNotes=prueba' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "CardNumber": - **** 6966,
    "DebitedAmount": 13.99,
    "AuthNo": 003279
}
Card/ReqZelleInfo
This method is used to request the info to where must send the ZELLE transfer.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIService/card/reqZelleInfo?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqBankID=TRU HTTP/1.1
Host: test.bgpay.me
                                                                                   
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIService/card/reqZelleInfo?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqBankID=TRU' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "CompanyName": "NOVISAD LLC",
    "ZelleEmail": "NVS4@NVSAD.COM "
}
Card/movilpay
This method is used to transfer funds from customers's account/card to "Pago-Mobil" (VEN ONLY).
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/movilpay/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=367&ReqPassword=7479&ReqAmount=10&ReqRecipient=4122072284
&ReqBankID=EF36A4BE-0B2E-11E6-823A-5254007B4F9D&ReqMessage=prueba HTTP/1.1
Host: test.bgpay.me
                               
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/movilpay/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=367&ReqPassword=7479
&ReqAmount=10&ReqRecipient=4122072284&ReqBankID=EF36A4BE-0B2E-11E6-823A-5254007B4F9D&ReqMessage=prueba' \
                                        
                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Response": "Envío de dinero a 4122072284",
    "TotalDebit": "336.00",
    "BankCodeID": "000000191398",
    "AuthNo": "004983"
}
Card/Visarequest
This method is used to request a Pre-Paid Visa GPS PAY Card.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/visarequest?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&
ReqPassword=0408&ReqAddress=15287 sw 12 st&ReqCityID=miami&ReqProvinceID=fl&ReqZipCode=33133&ReqPhone=7866833864 HTTP/1.1
Host: test.bgpay.me                                                                                        
                                                                                                                                   
                                
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/visarequest?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&ReqAddress=15287%20sw%2012%20st&
ReqCityID=miami&ReqProvinceID=fl&ReqZipCode=33133&ReqPhone=7866833864' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "AuthNo": 003170
}
Card/visaload
This method is used to transfer money from customer’s account to the Pre-Paid Visa GPS PAY Card. 
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/visaload?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&
ReqAmount=35&ReqVisaCardNumber=4342420000029222 HTTP/1.1
Host: test.bgpay.me                                                                                                                                                                               
                                                                                                                                   
                                
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/visaload?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&ReqAmount=35&ReqVisaCardNumber=4342420000029222' \

                                
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "AuthNo": 003171
}
Card/QRPay
This method is used to pay a Merchant from Customer’s account thru QR Code reading.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/qrpay?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=207&ReqCHolderID=155&ReqCPwd=0408&ReqStrTotal=25 HTTP/1.1
Host: test.bgpay.me
                                                                                                                                                                    
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/qrpay?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqMMerchantID=207&ReqCHolderID=155&ReqCPwd=0408&ReqStrTotal=25' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Customer":victor suarez,
    "Amount": 25,
    "AuthNo": 003172
}
Customer/Webpin
This method is used to change the customer’s Web PIN (to authorize web transactions).
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/webpin?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=226&ReqPassword=0408&ReqPIN1=2233&ReqPIN2=2233 HTTP/1.1
Host: test.bgpay.me
                                                                                                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/customer/webpin?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=226&ReqPassword=0408&ReqPIN1=2233&ReqPIN2=2233' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0
}
Customer/Password
This method is used to change the customer’s Login Password.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/password?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&
ReqCHolderID=184&ReqPIN1=2222&ReqPIN2=2222 HTTP/1.1
Host: test.bgpay.me                                        
                                                                                                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/customer/password?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=184&ReqPIN1=2222&ReqPIN2=2222' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0
}
Customer/Recovery_Access
This method is used to recovery the customer’s Login Password tru Email and Text Message.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/customer/recovery_access?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx
&SINTypeID=DN&ReqSIN=253571276&ReqCardNumber=6058150555183038&ReqBirthDate=3/11/1982 HTTP/1.1
Host: test.bgpay.me                                      
                                                                                                                                                                
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/customer/recovery_access?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&SINTypeID=DN&ReqSIN=253571276&ReqCardNumber=6058150555183038
&ReqBirthDate=3/11/1982' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0
}
Card/Tranreport
This method is used to fetch the list of recent last ten customer’s transactions.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/tranreport?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408 HTTP/1.1
Host: test.bgpay.me
                                                                                                                             
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/tranreport?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "Transacciones": [
        {
            "Fecha": "6/4/20",
            "Hora": "17:34:04",
            "AuthNo": "003172",
            "Transaccion": "Compra en un POS - Domestico SOSPetsafe C.A.",
            "Debito": 25,
            "Credito": 0,
            "Saldo": 5559.0675
        },
        {
            "Fecha": "6/4/20",
            "Hora": "16:39:39",
            "AuthNo": "003171",
            "Transaccion": "Transferencia de Fondos de cuenta GPS PAY a Tarjeta Prepaid/Debit **029222",
            "Debito": 37.95,
            "Credito": 0,
            "Saldo": 5584.0675
        },
        {
            "Fecha": "6/4/20",
            "Hora": "16:28:26",
            "AuthNo": "003170",
            "Transaccion": "Solicitar Tarjeta VISA/MC de Terceros",
            "Debito": 14.95,
            "Credito": 0,
            "Saldo": 5622.0175
        },
        {
            "Fecha": "6/4/20",
            "Hora": "16:28:26",
            "AuthNo": "003169",
            "Transaccion": "Manejo y Envio - Correo Regular Nacional",
            "Debito": 7,
            "Credito": 0,
            "Saldo": 5636.9675
        },
        {
            "Fecha": "6/4/20",
            "Hora": "16:15:09",
            "AuthNo": "003168",
            "Transaccion": "Transferencia de Fondos cuenta GPS PAY a cuenta GPS PAY  - ** 697297 prueba",
            "Debito": 13.95,
            "Credito": 0,
            "Saldo": 5643.9675
        }
    ]
}
Card/paypal
This method is used to load customer’s Account from PayPal(Customer must do the transfer on his/her PayPal Account on this Link:https://www.paypal.me/GPS PAYayments/ First).
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/loadpaypal?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&ReqAmount=10&ReqReferenceNo=725701995C050093B HTTP/1.1
Host: test.bgpay.me
                                                                                                                                                  
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/loadpaypal?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqPassword=0408&ReqAmount=10&ReqReferenceNo=725701995C050093B' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "AuthNo": 003173
}
Card/transtatus
This method is used to request Transaction Status
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/transtatus?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqAuthNo=003267 HTTP/1.1
Host: test.bgpay.me
                                                                                                                                                  
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location --request GET 'https://test.bgpay.me/APIServices/card/transtatus?
ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqCHolderID=155&ReqAuthNo=003267' \
    
                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Status": "3",
    "TransDate": "Jul 20 2020 12:00AM",
    "TransTime": "17:16:52"
}   

Note: Status 1="Pending"; 2="Aprobe"; 3="Cancel"
Card/venbanks
This method is used to get the VEN Banks list.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/venbanks?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx HTTP/1.1
Host: test.bgpay.me
                                                                                                                                                  
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/venbanks/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "Banks": [
        {
            "ID": 1,
            "BankID": "ef384dd5-0b2e-11e6-823a-5254007b4f9d",
            "BankName": "Banco, Banco Universal C.A",
            "BankCode": "0156"
        },
        {
            "ID": 2,
            "BankID": "ef393984-0b2e-11e6-823a-5254007b4f9d",
            "BankName": "Bancamiga Banco Microfinanciero C.A",
            "BankCode": "0172"
        },
        {
            "ID": 3,
            "BankID": "ef36f093-0b2e-11e6-823a-5254007b4f9d",
            "BankName": "Bancaribe C.A. Banco Universal",
            "BankCode": "0114"
        },
        ...............
        {
            "ID": 23,
            "BankID": "ef38741f-0b2e-11e6-823a-5254007b4f9d",
            "BankName": "DelSur Banco Universal, C.A",
            "BankCode": "0157"
        },
        {
            "ID": 24,
            "BankID": "ef38f72e-0b2e-11e6-823a-5254007b4f9d",
            "BankName": "Mi Banco Banco Microfinanciero C.A",
            "BankCode": "0169"
        },
        {
            "ID": 25,
            "BankID": "ef368105-0b2e-11e6-823a-5254007b4f9d",
            "BankName": "Venezolano de Credito, S.A. Banco Universal",
            "BankCode": "0104"
        }
    ]
}
Transfer/VENBanks
This method is used to send transfers to VEN Banks. 
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/transferven/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqAccessValue=7862223333&ReqStrTotal=2
&ReqAccessValueTo=4120414753 &ReqSIN=11789928&ReqBankID=0114&ReqMessage=prueba HTTP/1.1
Host: test.bgpay.me
                                                                 
                                                                                                                                                  
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/transferven/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx
&ReqAccessValue=7862223333&ReqStrTotal=2&ReqAccessValueTo=4120414753%20&ReqSIN=11789928&ReqBankID=0114&ReqMessage=prueba' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Response": "APROBADO",
    "TotalDebit": 2,
    "Fee": 2.8888,
    "Rate": "36.11",
    "TotalSent": 69.33,
    "BankCodeID": "000000977450",
    "AuthNo": "005419"
}
Card/drbanks
This method is used to get the Dom Republic Banks list.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/drbanks/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx HTTP/1.1
Host: test.bgpay.me
                                                                                                                                                  
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/drbanks/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "Banks": [
        {
            "BankID": "6",
            "BankName": "ASOC BONAO AHO Y PRE"
        },
        {
            "BankID": "9",
            "BankName": "ASOC CIBAO AHO Y PRE"
        },
        {
            "BankID": "25",
            "BankName": "ASOC LA NACIONAL AHO Y PRE"
        },
        ......................
        {
            "BankID": "39",
            "BankName": "CITIBANK N A"
        },
        {
            "BankID": "42",
            "BankName": "MOTOR CREDITO BCO AHO Y CRED"
        },
        {
            "BankID": "43",
            "BankName": "REPUBLIC BANK"
        },
        {
            "BankID": "48",
            "BankName": "SCOTIABANK"
        }
    ]
}
Card/DR_Beneficiary
This method is used to create a beneficiary for the transfer to DR.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/drbeneficiary/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqDocid=00116694578&ReqEmail=pedrocar@gmail.com
&ReqBankID=2&ReqCustName=pedro carmenates&ReqAccountNo=898025674 HTTP/1.1
Host: test.bgpay.me                                                                          
                                                                                                                                                  
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/drbeneficiary/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqDocid=00116694578
&ReqEmail=pedrocar%40gmail.com&ReqBankID=2&ReqCustName=pedro%20carmenates&ReqAccountNo=898025674' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "Benefid": "154879"
}
Transfer/DRBanks
This method is used to send the transfer to DR.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/transferDR/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx&ReqAccessValue=7862223333&ReqStrTotal=20
&ReqAccountNo=898025674&ReqCustFullName=pedro carmenates HTTP/1.1
Host: test.bgpay.me                                                                                    
                                                                                                                                                  
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/transferDR/?ReqMerchantID=154&ReqToken=i0mQHBMqDxa0UNgx
&ReqAccessValue=7862223333&ReqStrTotal=20&ReqAccountNo=898025674&ReqCustFullName=pedro%20carmenates' \   

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "TransferTo": "898025674",
    "DebitedAmount": "26.00",
    "Fee": "6.00",
    "Rate": "57.70",
    "TransferAmount": "1,154.00",
    "TransferID": "9123123258"
}
Transfer/TIGOMONEY
This method is used to to transfer funds to TIGOMONEY's customers in GTM.
<!HTTP CODE EXAMPLE REQUEST>
GET /APIServices/card/transfertigo/?ReqCHolderID=MzY5fDQ0NDc=&ReqStrTotal=10&ReqCardNumberTo=59195544&Notes=Prueba HTTP/1.1
Host: test.bgpay.me
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik5zR28zQmloaVFZM1JRWmpzS0Z3OSJ9.eyJpc3MiOiJodHRwczovL3l....
                                                                                                                             
                                    
<!cURL CODE EXAMPLE REQUEST>
curl --location 'https://test.bgpay.me/APIServices/card/transfertigo/?ReqCHolderID=MzY5fDQ0NDc=&ReqStrTotal=10&ReqCardNumberTo=59195544&Notes=Prueba' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik5zR28zQmloaVFZM1JRWmpzS0Z3OSJ9.eyJpc3MiOiJodHRwczovL3l.....' \

                                    
<!JSON CODE EXAMPLE RESPONSE>
{
    "ErrorCode": 0,
    "TransferTo": "59195544",
    "DebitedAmount": 10,
    "Fee": "3.75",
    "Rate": "7.814216",
    "TransferAmount": "48.84",
    "AuthNo": "005666"
}

Tables

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

Bank ID Codes
# CountryID BankID BankName
1 USA BOA Bank of America
2 USA CHA Chase Bank
3 USA WEL Well Fargo Bank
Valid SIN Type ID
# Valid ID Description
1 DL DRIVER LICENSE
2 DN DNI / CEDULA
3 PA PASSPORT
4 SS SOCIAL SECURITY
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 ReqFirstName String Customer’s First name
4 ReqLastName String Customer’s Last name
5 ReqMobileNo String Customer's cellular phone number (Numbers only)
6 ReqEmail String Customer’s email address (sample@format.com)
7 ReqCountryID String The Id of the country (USA, GTM, VEN, etc)
8 ReqToken String The token that is provided by BestGlobalPayments to the merchant for merchant identification.
9 ReqSINTypeID String The type of the Document ID (SIN ID) used
10 ReqSIN String The ID number as it appears on the customer identification
11 ReqCHolderID String The Account/card Holder ID Number
12 ReqPassword String Customer’s PIN Password
13 ReqBankID String “Bank id” registered in the BestGlobalPayments system (see Table)
14 ReqAmount String Amount to load account/card
15 ReqReferenceNo String Bank deposit reference No (or ZELLE)
16 ReqStrTotal String Amount to transfer to other Account/Card
17 ReqCardNumberTo String Account/card Number to transfer the amount
18 ReqPhone String Customer’s contact phone number (Numbers only)
19 ReqVisaCardNumber String The Visa Debit Card Number(only 16 digits)
20 ReqPIN1 String The new Customer’s Web PIN
21 ReqPIN2 String Retype the new Customer’s Web PIN
22 ReqMMerchantID String The 1st parameter of the QRCode String
23 ReqCPwd String Web Pin of the Customer Account/card
24 ReqStrTotal String Amount to Pay