Prepaid Service


http://webservices.gr8pay.net/v2/prepaid.svc

RegisterUser Method

Register new user and select the currency of the card that will be assigned to it (using Account assign method).

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
CurrencyYesStringCurrency of accountUSD

Response Fields

Field NameField TypeDescription
UserIDStringId of the newly created user, for authentication
C#JavaScriptPHP

AssignUser Method

Assign a new card to the user.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberThis parameter can be used to assign a card (using card's AccountId) from stock if you have it. The card must not be assigned to another user. If this data is not sent, then the system generates a new electronic card and AccountId number for this user, using the currency selected on Register user method.1E+15

Response Fields

Field NameField TypeDescription
AccountIDNumberAssigned AccountId
AccountNumStringAssigned card number
C#JavaScriptPHP

UpdateUserInfo Method

This method allows you to update the user’s name on the card program – this method can only be used once – when used a second time the request will be rejected.

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
firstnameYesStringUser’s first name
LastnameYesStringUser’s last name
WhoregistersnameYesStringName of who updated name
MiddlenameNoStringUser’s middle name
SecondlastnameNoStringUser’s second last name

Response Fields

The service only returns a status message
C#JavaScriptPHP

UpdateUserAddress Method

Update user’s address.

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
StreetYesStringStreet address
NumStreetYesStringStreet number
NumAptYesStringApt number of address
CountryIsoYesIntID of country of the user address
CountryYesStringCountry name of the user address
StateISOCodeYesintId of state of the user address
StateYesStringState name of the user address
CityYesStringCity name of the user address
ZipCodeYesStringZip code of the user address
SuburbYesStringSuburb

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

RegisterUserPersonalInfo Method

Update user’s personal information.

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
BirthdateYesStringUser’s birth date (yyyMMdd)
GenderedYesStringUser’s gender id (1-Male, 2-Female)
countrybirthISOCodeYesStringUser’s country birth id
OccupationidYesIntUser’s occupation id
1-“BUSINESSMAN”
2-“EMPLOYEE’
3-“STUDENT”
4-“HOUSEWIFE”
5-“RETIRED”

Response Fields

The service only returns a status message
C#JavaScriptPHP

UpdateUserOccupation Method

Update user’s occupation data.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
OccupationidYesIntUser’s occupation id
1-“BUSINESSMAN”
2-“EMPLOYEE’
3-“STUDENT”
4-“HOUSEWIFE”
5-“RETIRED”

Response Fields

The service only returns a status message
C#JavaScriptPHP

SearchUserInfo Method

Update user’s occupation data.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
emailYesStringEmail to search (1), you need to send at least one of the fields
countrycodeYesStringCountry code to search, (2) you need to send at least one of the fields
cellphoneYesStringCellphone to search (3), you need to send at least one of the fields

Response Fields

Field NameField TypeDescription
UserInfoStringThe currency for the User created
GenderIdStringUser’s occupation id:
1-“BUSINESSMAN”
2-“EMPLOYEE”
3-“STUDENT”
4-“HOUSEWIFE”
5-“RETIRED”
UserIdStringThe currency for the User created
BirthDateStringBirth date of user. Format: YYYMMDD
CellPhoneStringCellphone number
CountryCodeStringThe country code
CurrencyStringThe currency for the user created
EmailStringEmail
LastNameStringLast Name
MiddleNameStringMiddle Name
MotherLastNameStringLast Name
NameStringName
TaxpayerRegistrationStringTax Payer Registration
UsernameStringUser Name
CountryIdIntCountry ID
StateIdIntState ID
CityStringCity
CountryStringCountry
NumAptStringNumApt
StreetStringStreet
StateStringState
SuburbStringSuburb
ZipCodeStringZip Code
C#JavaScriptPHP

ActivateCard Method

Activate a card in order to the user can do transactions with it.To be able to perform the activation, all the information and documentation of the user must be validated beforehand.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated
ValidThruYesStringMonth and year of expiration (MMyy)
SecurityCodeYesStringSecurity code printed on the reverse of the card

Response Fields

Result of request, contains code and description
C#JavaScriptPHP

BlockCard Method

Activate a card in order to the user can do transactions with it.To be able to perform the activation, all the information and documentation of the user must be validated beforehand.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated
PINYesStringPersonal identification number. You can update this on PIN assignment method.

Response Fields

Result of request, contains code and description
C#JavaScriptPHP

CardStatus Method

Retrieve the current status of an existing card.To be able to perform the activation, all the information and documentation of the user must be validated beforehand.

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
CurrentAccountIdYesNumberId of the card to be activated
NewAccountIdYesNumberId of the card to be activated

Response Fields

Field NameField TypeDescription
OnlineSecurityStringIndicates if extra security protection for online shopping is active
CardStateStringCard State
CardStatusStringCard Status
RequestedCardsStringRequested cards
OnlineSecurityDateStringActivation date of extra security protection for online shopping
C#JavaScriptPHP

CardReplace Method

Replace a card for a new one, this operation also moves the balance of the old card to the new card.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
CurrentAccountIdYesNumberId of the card to be activated
NewAccountIdYesNumberId of the card to be activated

Response Fields

Field NameField TypeDescription
NewAccountIDNumberNew Account ID
NewCardNumStringNew Card Number
C#JavaScriptPHP

CardInfo Method

Replace a card for a new one, this operation also moves the balance of the old card to the new card.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated

Response Fields

Field NameField TypeDescription
BarcodeStringString bar code ID
BarCode2StringString bar code ID
CardNumStringCard Number
CardStateStringCard State
CurrencyStringCurrency
MonthStringMonth
SecurityCodeStringSecurity Code
YearStringYear
C#JavaScriptPHP

CardPin Method

Card PIN assignment.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated
ValidThruYesStringValidThru
SecurityCodeYesStringSecurityCode
PINYesStringPIN

Response Fields

Success or failure message
C#JavaScriptPHP

CardUnlock Method

Unblock a blocked card.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated
PINYesStringPIN

Response Fields

Result of request, contains code and description
C#JavaScriptPHP

CardReplace Method

Replace a card for a new one, this operation also moves the balance of the old card to the new card.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated
NewAccountIdYesNumberNew Account ID

Response Fields

Field NameField TypeDescription
AccountIdNumberId of the card to be activated
NewAccountIdNumberNew Account ID
C#JavaScriptPHP

UserAccountList Method

Replace a card for a new one, this operation also moves the balance of the old card to the new card.

Request Fields

Empty body request

Response Fields

Field NameField TypeDescription
AccountIdNumberId of the card to be activated
AccountNumNumberAccount Number
CurrencyNumberCurrency
BalanceNumberBalance
CardStatusStringCardSatatus
CardStatusIDIntCardStatus ID
CardIntCard
AliasStringAlias
C#JavaScriptPHP

AccountAdd Method

Adds a new electronic additional or a physical card account to user.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated
CurrencyYesStringThe currency for the User created
C#JavaScriptPHP

Balance Method

Checks the balance of the card.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated

Response Fields

Field NameField TypeDescription
AccountBalanceNumberAccount Balance
AvailableBalanceDecimalAvailableBalance
CurrentBalanceDecimalCurrentBalance
AverageBalanceDecimalAverageBalance
DailyLoadDecimalDailyLoad
DailyChargeDecimalDaily Charge
CLABEDecimalClabe
C#JavaScriptPHP

RecentTransactionDetails Method

List the latest 5 transactions and the balance of the account (detailed).

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountIdYesNumberId of the card to be activated

Response Fields

Field NameField TypeDescription
AccountBalanceNumberAccount Balance
AvailableBalanceDecimalAvailableBalance
CurrentBalanceDecimalCurrentBalance
TransactionListStringTransaction List
TransactionStringTransaction
AuthorizationStringAuthorization
DescriptionStringDescription
MovDateDateMov Date
ConfDateDateConf Date
LoadDecimalLoad
ChargeStringCharge
BalanceDecimalBalance
BalanceDecimalBalance
CurrencyStringCurrency
C#JavaScriptPHP

TransactionSearchByDate Method

Search for the details of a specific transaction date.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
DateFromYesDateDate From
DateToYesDateDate To

Response Fields

Field NameField TypeDescription
AccountBalanceNumberAccount Balance
AvailableBalanceDecimalAvailableBalance
CurrentBalanceDecimalCurrentBalance
TransactionListStringTransaction List
TransactionStringTransaction
AuthorizationStringAuthorization
DescriptionStringDescription
MovDateDateMov Date
ConfDateDateConf Date
LoadDecimalLoad
ChargeStringCharge
BalanceDecimalBalance
BalanceDecimalBalance
CurrencyStringCurrency
C#JavaScriptPHP

TransactionSearchByNum Method

Search for the details of a specific transaction number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
TransactionNumYesStringTransaction number

Response Fields

Field NameField TypeDescription
AccountBalanceNumberAccount Balance
AvailableBalanceDecimalAvailableBalance
CurrentBalanceDecimalCurrentBalance
TransactionListStringTransaction List
TransactionStringTransaction
AuthorizationStringAuthorization
DescriptionStringDescription
MovDateDateMov Date
ConfDateDateConf Date
LoadDecimalLoad
ChargeStringCharge
BalanceDecimalBalance
BalanceDecimalBalance
CurrencyStringCurrency
C#JavaScriptPHP

TransactionStatus Method

Return detailed transaction status for a specific transaction number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
TransactionNumYesStringTransaction number

Response Fields

Field NameField TypeDescription
TransactionStatusStringTransaction Status
TransactionStatusIDDecimalTransactionStatus ID
C#JavaScriptPHP

TransferMoney2Wallet Method

Send money between two wallet accounts of different users. The destination card must not be cancelled (active, inactive, blocked are valid status).

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AmountYesDecimalAmount to send
CurrencyYesStringThe currency for the transfer
CurrencyYesStringCurrency
ConceptYesStringDescription of money transfer
AccountIDYesNumberId of the account to be charge in case the user has two or more accounts. If not send, the charge will be done to user's master account
AccountNumYesNumberAccount Number
CellPhoneYesStringCell Phone Number
EmailYesStringEmail
RecipientUserIdYesStringRecipientUserId

Response Fields

Field NameField TypeDescription
CustomerSummaryStringContains user identity to confirm load funds and customer token for settle
CustomerTokenStringCustomer token
CustomerNameStringCustomer Name
TransactionStringContains a summary of created transaction, and Transaction number to for settle
TransactionNumStringTransaction number
SummaryStringSummary of transaction
AmountDecimalAmount of transaction
FeeDecimalAmount of transaction
TotalIntTotal of transaction
ConfirmDateDateTransaction’s confirmation date
ExchangeFacStringExchange factor used on transaction
CurrencyStringCurrency of transaction
RecipientStringRecipient's name
C#JavaScriptPHP

PreviousRecipientsList Method

Retrieve previous money transfer recipients list for money transfer to wallet.

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
TypeSearchYesStringType of search (1=Frequently; 2=Recents)

Response Fields

Field NameField TypeDescription
PreviousRecipientsStringList of previous recipients used for transactions
TransactionStatusIdStringTransaction id on lists
RecipientNameStringRecipient's name for transaction
AccountNumStringRecipient's account number
CountryCodeStringRecipient's cellphone country code
CellphoneStringRecipient's cellphone
EmailStringRecipient's email
LastTransactionStringLast transaction date
TotalTransactionStringTotal transactions made with recipient
C#JavaScriptPHP