This service is used to retrieve the fund information belonging to customer.

POST /cx/fund

Request

Parameters
No Parameters

This service is used to retrieve the fund history of the customer.

POST /cx/fundactivities

Request

Parameters
Parameter Type Max Length Required Sample Notes
monthsAgo numeric 10 No 0

The past month from the current month

0 - means current month

1 - will be previous month

currency string 10 No 0

currency provided. sample values are PHP, USD, EUR etc ...

This service is used to check if the given device id is valid

POST /pub/checkposdevice

Request

Parameters
Parameter Type Max Length Required Notes
deviceId string 20 Yes The ID of the device

This service is used to send funds from one wallet to another. There are three calls - you need to initialize the transaction, submit the form and confirm the transaction.

Initialization

POST /cx/txn/peertransfer/init

Request

Parameters
No Parameters

Submission

POST /cx/txn/peertransfer/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
amount numeric 10 Yes 50.00 Amount of the transaction
txnMessage string 150 No For friend's birthday Memo or notes for transaction
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
targetEntityId string 30 Yes (if targetEmailAddress and targetMobilePhone is not present) 11111111 Customer unique ID
targetEmailAddress string 30 Yes (if targetEntityId and targetMobilePhone is not present) This email address is being protected from spambots. You need JavaScript enabled to view it. Customer email address
targetMobilePhone string 30 Yes (if targetEntityId and targetEmailAddress is not present) 6391512312234/td> Customer mobile number
authzRequired string 10 No true

Valid values are: true or false

To require customer transaction PIN verification using authorizeTxn.sctl, provide this parameter with value = true

Confirmation

POST /cx/txn/peertransfer/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to send funds from one wallet to multiple wallets in bulk. The system accepts a comma-delimited, multipart file (CSV) which contains a set given number of parameters.

Multipart/Form-data   POST /cx/txn/bulkpeertransfer

Request

CSV file contains the following ( each comma delimited ):
Parameter Type Max Length Required Sample Notes
Email string 80 Yes This email address is being protected from spambots. You need JavaScript enabled to view it. Email of the recipient
Amount numeric 10 Yes 50.00 Amount of transaction
See sample csv file here

This service is used to send funds a wallet to a recipient's prepaid card. There are three calls - you need to initialize the transaction, submit the form and confirm the transaction.

Initialization

POST /cx/txn/cardload/init

Request

Parameters
No Parameters

Submission

POST /cx/txn/cardload/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
sourceAmount numeric 10 Yes 50.00 Amount of the transaction
sendToCard boolean 5 Yes true Do you allow to send to other's prepaid card? If so, set as true
targetEntityId string 30 Yes (If targetEmailAddress is not present) 11111111 Customer unique ID
targetEmailAddress string 30 Yes (If targetEntityId is not present) This email address is being protected from spambots. You need JavaScript enabled to view it. Customer email address
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
targetCardNetwork string 10 No MasterCard

The generalized type of card

Valid values are: Visa, MasterCard

Confirmation

POST /cx/txn/cardload/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to send funds from one wallet to multiple prepaid cards in bulk. The system accepts a comma-delimited, multipart file (CSV) which contains a set given number of parameters.

Since card loads are not instantaeous, and some individuals may not have active cards tied to their account, therefore all submitted requests go into pending state immediately unless the associated user does not have an active card.

Multipart/Form-data   POST /cx/txn/bulkcardload

Request

CSV file contains the following ( each comma delimited ):
Parameter Type Max Length Required Sample Notes
Email string 80 Yes This email address is being protected from spambots. You need JavaScript enabled to view it. Email of the recipient
Amount numeric 10 Yes 50.00 Amount of transaction
See sample csv file here

This service is used to send eGive cash. There are three calls - you need to initialize the transaction, submit the form and confirm the transaction.

Initialization

POST /cx/txn/cashvoucherout/init

Request

Parameters
No Parameters

Submission

POST /cx/txn/cashvoucherout/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
sourceAmount numeric 10 Yes 500.00

Amount of the transaction

The minimum amount is 500 and the maximum is 10,000.

The amount must only be divisible by 100.

txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
targetMobile numeric 15 Yes 639111111111 Mobile phone number
targetName string 30 Yes John Doe Recipient's name

Confirmation

POST /cx/txn/cashvoucherout/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to funds instantly from customer's online web banking.

Initialization

POST /cx/txn/onlineotc/init

Request

Parameters
Parameter Type Max Length Required Sample Notes
type string 20 Yes OTC_ONLINE The type of transaction

Submission

POST /cx/txn/onlineotc/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
amount numeric 10 Yes 500.00 The minimum amount is 500.00
svcType string 20 Yes OTC_ONLINE The type of transaction
currency string 20 Yes PHP The currency of transaction

Confirmation

POST /cx/txn/onlineotc/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to funds instantly from payment centers.

Initialization

POST /cx/txn/onlineotc/init

Request

Parameters
Parameter Type Max Length Required Sample Notes
type string 20 Yes OTC_ONLINE The type of transaction

Submission

POST /cx/txn/onlineotc/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
amount numeric 10 Yes 500.00 The minimum amount is 500.00
svcType string 20 Yes OTC_ATM The type of transaction
currency string 20 Yes PHP The currency of transaction

Confirmation

POST /cx/txn/onlineotc/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to funds instantly from gcash.

Initialization

POST /cx/txn/onlineotc/init

Request

Parameters
Parameter Type Max Length Required Sample Notes
type string 20 Yes GCASH The type of transaction

Submission

POST /cx/txn/onlineotc/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
amount numeric 10 Yes 500.00 The minimum amount is 500.00
svcType string 20 Yes GCASH The type of transaction
currency string 20 Yes PHP The currency of transaction

Confirmation

POST /cx/txn/onlineotc/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to withdraw funds to customer's bank account. There are three calls - you need to initialize the transaction, submit the form and confirm the transaction.

Initialization

POST /cx/txn/banktransfer/init

Request

Parameters
No Parameters

Submission

POST /cx/txn/banktransfer/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
bankCode string 3 Yes ALL

Valid Bank Codes are:

  • ALL - Allied Bank
  • ASB - Allied Savings Bank
  • AUB - Asia United Bank
  • BF - Banco Filipino
  • BSJ - Banco San Juan
  • CBC - Chinabank
  • CBI - Centennial Savings Bank
  • CBS - Chinabank Savings
  • CCB - Chinatrust Bank
  • CSB - Citystate Savings Bank
  • CSI - Citibank Savings
  • CTB - Citibank
  • DBP - DBP
  • EIB - Export and Industry Bank
  • EWB - East West Bank
  • LBP - Landbank
  • MBC - Manila Bank
  • MET - Metrobank
  • MPI - MayBank
  • MSB - Malayan Bank
  • OMB - OK Bank
  • PBB - Philippine Business Bank
  • PBC - PBCOM
  • PNB - Philippine National Bank
  • PPB - Postal Bank
  • PSB - PSBank
  • PTC - Philtrust Bank
  • QRB - QCRB
  • RBI - Real Bank
  • RBN - Robinsons Bank
  • RCB - RCBC
  • RSB - RCBC Savings Bank
  • SBA - Sterling Bank
  • SCB - Standard Chartered Bank
  • SEC - Security Bank
  • TYB - TongYang Bank
  • WPB - World Partners Bank
accountNumber numeric 20 Yes 0000000000000000 The account no. of customer's bank account
accountName string 30 Yes John Doe The account name of customer's bank account
txnNote string 150 No Example Note Memo or notes for transaction
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
sourceAmount numeric 10 Yes 50.00 Amount of the transaction

Confirmation

POST /cx/txn/banktransfer/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to load customer's own prepaid mastercard. There are three calls - you need to initialize the transaction, submit the form and confirm the transaction.

Initialization

POST /cx/txn/cardload/init

Request

Parameters
No Parameters

Submission

POST /cx/txn/cardload/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
sourceAmount numeric 10 Yes 50.00 Amount of the transaction
sendToCard boolean 5 Yes true Do you allow to send to other's prepaid card? If so, set as true
targetEntityId string 30 Yes (If targetEmailAddress is not present) 11111111 Customer unique ID
targetEmailAddress string 30 Yes (If targetEntityId is not present) This email address is being protected from spambots. You need JavaScript enabled to view it. Customer email address
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
targetCardNetwork string 10 No MasterCard

The generalized type of card

Valid values are: Visa, MasterCard

Confirmation

POST /cx/txn/cardload/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to pay bills online. There are three calls - you need to initialize the transaction, submit the form and confirm the transaction.

Initialization

POST /cx/txn/billpayment/init

Request

Parameters
No Parameters

Submission

POST /cx/txn/billpayment/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
payeeCode numeric 5 Yes 10001 The unique biller's code
payeeRef string 20 Yes 0000000000 The subscriber / reference no.
txnNote string 150 Yes Postpaid payment Memo or notes for transaction
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
targetAmount numeric 10 Yes 599.00 The amount to be paid

Confirmation

POST /cx/txn/billpayment/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to buy prepaid loads online. There are three calls - you need to initialize the transaction, submit the form and confirm the transaction.

Initialization

POST /cx/txn/purchase/init

Request

Parameters
Parameter Type Max Length Required Sample Notes
productGroup string 20 No CALL CARDS The name of the group of prepaid load products

Submission

POST /cx/txn/purchase/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
phoneNumber numeric 15 Yes 09********* The mobile no. to be loaded
productGroup string 20 Yes CALL CARDS The name of the group of prepaid load products
targetAmount numeric 10 Yes 15.00 The amount to be loaded
targetCurrency string 3 Yes PHP The currency of the transaction
productCode string 10 Yes SM15 The unique code of the prepaid load product

Confirmation

POST /cx/txn/purchase/confirm

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call

This service is used to retrieve the prepaid mastercard information of the customer.

GET /cx/card/{cardId}

Request

Parameters
No Parameters

This service is used to retrieve the prepaid card list information of the customer.

GET /cx/cards

Request

Parameters
No Parameters

This service is used to initiate a request for a prepaid MasterCard for consumer. There are two calls - you need to initialize the transaction and submit the request. Note: This call should only be accessible once the consumer's status is VERIFIED.

Initialization

POST /cx/requestcard/init

Request

Parameters
No Parameters

Submission

POST /cx/requestcard

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
cardType string 10 Yes VMONEY Card Type can be:
  1. VMONEY
  2. PLATINUM
  3. DOT
deliveryType string 80 Yes SHIPPING Delivery Type can be:
  1. SHIPPING
  2. PICKUP

This service is used to activate a Prepaid MasterCard once it's been assigned to a customer.

Initialization

POST /cx/activatecard/init

Request

Parameters
No Parameters

Submission

POST /cx/activatecard

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
cardNumber numerical 16 Yes 5555333355554444 16 Digit Card Number
activationKey string 18 Yes J8e9p374J8 The string provided to the customer after requesting for a card.

This service is used to retrieve the POS device information of the customer.

GET /cx/posdevices

Request

Parameters
No Parameters

This service is used to initiate a request for a privilege card for consumer.

Submission

POST /cx/requestposdevice

Request

Parameters
Parameter Type Max Length Required Sample Notes
deviceType string 20 Yes CARD CARD is the device type for privilege card

This service is used to activate the privilege card for the customer.

Submission

POST /cx/privcard/activate

Request

Parameters
Parameter Type Max Length Required Sample Notes
serialCode string 10 Yes 001-000001 The serial code of the privilege card
cardNumber numeric 14 Yes 10010010010010 The unique 14-digit privilege card no.
customerPin numeric 4 Yes 1111 Security PIN user sets. Used as second authentication.

This service is used to request funds to other customers.

Initialization

POST /cx/txn/peertransfer/init

Request

Parameters
No Parameters

Submission

POST /cx/peertransferrequest/submit

Request

Parameters
Parameter Type Max Length Required Sample Notes
amount numeric 10 Yes 50.00 Amount of the transaction
txnMessage string 150 No For friend's birthday Memo or notes for transaction
txnControlId numeric 30 Yes 19277282929 Control ID returned from init call
requesteeEmailAddress string 80 Yes This email address is being protected from spambots. You need JavaScript enabled to view it. Email of recipient

This service is used to redeem promo code.

Submission

POST /cx/redeempromocode

Request

Parameters
Parameter Type Max Length Required Sample Notes
promoCode string 10 Yes ab12cd34ef The 10-character promo code to be redeemed

This service is used to pay merchant.

Submission

POST /cx/txn/paymerchant/process

Request

Parameters
Parameter Type Max Length Required Sample Notes
merchantId string 15 Yes M999999999999 Merchant unique ID
billAmount numeric 10 Yes 50.00 Amount of the transaction
billCurrency string 3 Yes PHP The currency of the transaction
merchantRef string 20 No 1234 Merchant reference number
payDesc string 255 No Payment for purchased item The description of payment

This service is used to retrieve service based transaction fees.

POST /cx/calctxnfee

Request

Parameters
Parameter Type Max Length Required Sample Notes
amount numeric 10 Yes 50.00 Amount of the transaction
currency string 3 Yes PHP Currency of amount
feeCode string 50 Yes WDRAW_CARD Specific code related to the service function.
Fee Codes

The following table displays the possible fee codes.

feeCode Description
PREPAID_CARD_VMONEY Request Prepaid Card - VMoney
PREPAID_CARD_PREMIER Request Prepaid Card - Premier
PREPAID_CARD_DOT Request Prepaid Card - DOT
SHIPPING_CARD_DEVICE_VMONEY Shipping Card/Device - VMoney
SHIPPING_CARD_DEVICE_PREMIER Shipping Card/Device - Premier
SHIPPING_CARD_DEVICE_DOT Shipping Card/Device - DOT
PRIVILEDGE_CARD Privilege Card
WDRAW_CARD Prepaid MasterCard Load
WDRAW_CARD_UNOWNED Load Other Prepaid MasterCard
TRANSFER Wallet to wallet transfer
REQUEST Fund Request
PURCHASE Buy Prepaid Service
WDRAW_BANK Withdraw to Bank Account
BILLPAYMENT Bill Payment
OTC_ONLINE Add Funds via Web Banking
OTC_ATM Add Funds via In Person/ATM(Banks)
OTC_OTHERS In Person/ATM(Non-Banks)
GCASH Add Funds via Globe GCash

This service is used to retrieve the transaction details of the customer.

GET /cx/txn/{txnId}

Request

Parameters
Parameter Type Max Length Required Sample Notes
txnId numeric 10 Yes 1111  

The following table displays the error codes that can be returned within the response from VMoney

Status Code Description
200 OK The request was successful and the response body contains the representation requested.
400 BAD REQUEST The request was invalid or cannot be otherwise served. For example this can happen due to missing required parameter or invalid parameter type.
403 FORBIDDEN The request has been refused. See the accompanying message for the specific reason. In most cases this status is returned when user authentication fails (sample response: {"msgCode": "00001","msgText": "Authentication Required"} ).
404 NOT FOUND The URI requested is invalid and cannot be found.
417 Expectation Failed This happens when invalid transaction flow is detected - usually due to incorrect txnControlId passed in the request.
422 Unprocessable Entity The request was well-formed but was unable to be followed due to errors. Any validation error such as invalid input value, exceeding transaction limit, etc is returned with this status. See the accompanying message for the specific reason. The validation error is in this format:
            {
                "msgCode": "FLD.ERRORS",
                "msgText": "Field validation errors",
                "fieldErrors": [
                    {
                        "field": "sourceCurrency",
                        "code": "INVLD.VALUE",
                        "defaultMessage": "Invalid source currency"
                    },
                    {
                        "field": "targetCurrency",
                        "code": "INVLD.VALUE",
                        "defaultMessage": "Invalid target currency"
                    },
                    {
                        "field": "sourceAmount",
                        "code": "INVLD.VALUE",
                        "defaultMessage": "Amount must be greater than 0"
                    }
                ]
            }


        
Or in this format
            {
                "msgCode": "SYS.ERR",
                "msgText": "Customer record not found"
            }
        
500 INTERNAL SERVER ERROR Something went wrong. Please contact technical support.