This service is used to register a user with basic amount of information. User will need to activate their account once this step is complete.

POST /cx/signup

Request

Parameters
Parameter Type Max Length Required Sample Notes
loginId string 50 Yes 639111111111 User's email address or mobile phone no. with country code
loginPass string 20 Yes s3cr3tp4ssw0rd Password (min 8 chars, no special chars or spaces)
referredBy string 20 No 78Csh987s920 Referral Code
signupHost string 30 Yes https://test.com Host URL

This service is used to activate the registered user account by using the activation key sent by email.

GET /cx/activate/{activationKey}

Request

Parameters
Parameter Type Max Length Required Sample Notes
activationKey string 20 Yes aBcDe1FgHiJ2kLmNo3Pq The activation key

This service is used to register a user with basic amount of information.

POST /cx/submitbasicinfo

Request

Parameters
Parameter Type Max Length Required Sample Notes
title string 20 No Mr User's title / salutation
gender string 1 No

Valid values are:

  • M - for Male
  • F - for Female
  • O - for Other
User's gender
firstName string 30 Yes Maria User's first name
lastName string 30 Yes Tarango User's last name
emailAddress string 50 No This email address is being protected from spambots. You need JavaScript enabled to view it. User's email address
birthMm numeric 2 Yes 3 User's date of birth - month
birthDd numeric 2 Yes 24 User's date of birth - month
birthYear numeric 4 Yes 1967 User's date of birth - year
numberStreet string 40 Yes 123 ABC Street Street Address
addressExtraInfo string 40 No #4 Unit Additional Address Information
cityTown string 20 Yes Manila City or Town
provState string 50 Yes Metro Manila Province or State
postalCode string 8 Yes 92817 Postal or Zip Code
country string 2 Yes PH Country (ISO format)
homePhone numeric 15 No 5558889090 Home Phone Number
mobilePhone numeric 15 No 639111111111 Mobile Phone Number
authzCode numeric 4 Yes 1111 Security PIN user sets. Used as second authentication.

This service is used to log a user in.

POST /cx/login

Request

Parameters
Parameter Type Max Length Required Sample Notes
loginHost string 30 Yes https://test.vmoney.com Host Url
loginId string 50 Yes This email address is being protected from spambots. You need JavaScript enabled to view it. Email Address or Mobile Phone ( Country Code + number, ex. 639********* )
loginPass string 20 Yes password1234 Password (min 8 chars, has at least one numeric character, no special chars or spaces)

This service is used to log a user in via mobile number + PIN

POST /cx/login-phoneauthz

Request

Parameters
Parameter Type Max Length Required Sample Notes
phoneNumber numeric 15 Yes 639111111111 Mobile Phone Number
authzCode numeric 4 Yes 1111 Security PIN user sets. Used as second authentication.
loginHost string 30 Yes https://test.vmoney.com Host Url

This service is used to log a user out and remove session.

POST /cx/logout

Request

Parameters
No Parameters

This service is used to check session.

POST /cx/sessioncheck

Request

Parameters
No Parameters

This service is used to request a temporary password when the user forgot his/her password.

POST /cx/processforgotpw

Request

Parameters
Parameter Type Max Length Required Sample Notes
loginId string 50 Yes This email address is being protected from spambots. You need JavaScript enabled to view it. The registered email address of the user
siteHost string 30 Yes https://test.vmoney.com Host Url

This service is used to change the user's current password.

POST /cx/changepw

Request

Parameters
Parameter Type Max Length Required Sample Notes
currentPw string 20 Yes password1234 Old Password (min 8 chars, has at least one numeric character, no special chars or spaces)
newPw1 string 20 Yes password1234 New password (min 8 chars, has at least one numeric character, no special chars or spaces)
newPw2 string 20 Yes password1234 Re-entered new password (min 8 chars, has at least one numeric character, no special chars or spaces)

This service is used to change the user's current PIN.

POST /cx/changepin

Request

Parameters
Parameter Type Max Length Required Sample Notes
currentPin string 4 Yes 1234 User's current pin
newPin1 string 4 Yes 4321 User's new pin
newPin2 string 4 Yes 4321 Re-entered user's new pin

This service is used to retrieve customer profile information.

GET /cx/profile

Request

Parameters
No Parameters

This service is used to update customer profile information.

POST /cx/profile/updatecontact

Request

Parameters
Parameter Type Max Length Required Sample Notes
title string 20 No Mr User's title / salutation
numberStreet string 40 Yes 123 ABC Street Street Address
cityTown string 20 Yes Manila City or Town
provState string 50 Yes Metro Manila Province or State
country string 2 Yes PH Country (ISO format)
postalCode string 8 Yes 92817 Postal or Zip Code
mobilePhone numeric 15 Yes 5558881111 Mobile Phone Number
homePhone numeric 15 No 5558889090 Home Phone Number

This service is used to update customer profile information.

POST /cx/profile/updateextended

Request

Parameters
Parameter Type Max Length Required Sample Notes
nationality string 2 Yes PH Country (ISO format)
placeOfBirth string 50 Yes Sample Hospital, Sample City, Sample Place of Birth
occupation string 40 Yes Carpenter Occupation / Position / Work
natureOfWork string 40 Yes Information Technology Fields of Industry
identityNumber string 20 Yes 1234-1234 Government Issued ID No.
mothersMaidenName string 40 Yes Nissibeth Llorera Mother's maiden name
maritalStatus string 1 Yes M Marital Status
employer string 40 Yes Test Inc. Company / individual that employs the user

This service is used to retrieved the customer's profile picture.

GET /cx/showavatar/

Request

Parameters
No Parameters

This service is used to upload/submit profile picture.

POST /cx/avatar/upload

Request

Parameters
Parameter Type Max Length Required Sample Notes
avatarImageFile file - Yes - Image file

This service is used to upload/submit a document for customer ID verification.

POST /cx/uploadpoid

Request

Parameters
Parameter Type Max Length Required Sample Notes
poidType string 100 Yes Driver's License ID Type. This could be Driver's License, Passport, Social Security Card, Tax Identification Card, Citizenship Card, NBI Certificate, Other
poidDescription string 100 No State ID Card This parameter is only needed if poidType is "Other". If Other, then system requires the specified ID type to be passed.
poidImageFile file - Yes - File image

This service is used to retrieved the list of customer's subscription by status

GET /cx/dp/subscribers/{status}

Request

Parameters
Parameter Type Max Length Required Sample Notes
status string 10 Yes AWAIT

Valid values are:

  • AWAIT - for subscriptions awaiting acceptance
  • ACCEPTED - for accepted subscriptions
  • PAUSED - for paused subscriptions
  • DECLINED - for declined subscriptions
  • REMOVED - for removed subscriptions

This service is used to retrieved the details of the subscription

GET /pub/dp/{programId}

Request

Parameters
Parameter Type Max Length Required Sample Notes
programId numeric 11 Yes 1 The id of the subscription

This service is used to accept or decline subscription awaiting acceptance

POST /cx/dp/updatesubscriber

Request

Parameters
Parameter Type Max Length Required Sample Notes
programId numeric 11 Yes 1 The id of the subscription
status string 10 Yes 1

The status of the subscription:

  • AWAIT - for subscriptions awaiting acceptance
  • ACCEPTED - for accepted subscriptions
  • PAUSED - for paused subscriptions
  • DECLINED - for declined subscriptions
  • REMOVED - for removed subscriptions

This service is used to retrieved the subscription transactions.

GET /cx/dp/subscribertxn/{programId}

Request

Parameters
Parameter Type Max Length Required Sample Notes
programId numeric 11 Yes 1 The id of the subscription

This service is used to retrieve the contacts of the customer.

GET /cx/contacts

Request

Parameters
No Parameters

This service is used to add new contact to the customer's contact list.

POST /cx/addcontact

Request

Parameters
Parameter Type Max Length Required Sample Notes
contactEntityId string 50 Yes (if contactEmail or contactMobile is not present) 1386622785292 The entityId of the contact to be added
contactEmail string 50 Yes (if contactEntityId or contactMobile is not present) This email address is being protected from spambots. You need JavaScript enabled to view it. The Email Address of the contact to be added
contactMobile string 50 Yes (if contactEntityId or contactEmail is not present) 639121234567 The mobile number of the contact to be added

This service is used to send a referral email to the given email addresses.

POST /cx/invite

Request

Parameters
Parameter Type Max Length Required Sample Notes
invitees string 255 Yes This email address is being protected from spambots. You need JavaScript enabled to view it. The list of invitees, which are separated by newline

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.