User Tools

Site Tools


uwcfsquickcard

Table of Contents

Description of the UWCFSQuickCard API.

1. Web-service address

Test web service address (for testing purposes) https://testapi.moneypolo.com:26443/UWCFSQuickCard.asmx

Real web service address https://api.moneypolo.com:26442/UWCFSQuickCard.asmx

Please note, that test and prod keys are different from each other. Working key will be issued by MoneyPolo company at the end of the testing period.

2. Security, general description of card usage

Each transmitted request must be signed with the key. The UWCFS Company issues the key to the Agent at the beginning of testing. The key is changed when moving to the operational service variant.

Access to web service can be restricted by IP (on client’s demand) Each transmitted request must be signed with a key. MoneyPolo issues a key for the merchant at the beginning of testing. When switching to the operating mode of the service the key is changed. MoneyPolo will distribute “keys” among their clients, which has to be transmitted to web service in parametrical form.

  1. To work with the API, merchant must assign a unique RUID identifier to each client that will be transmit to the appropriate Web service methods.
  2. When opening the account, receiving a card application, card or transaction status changing, etc., the MoneyPolo sends a letter to the Merchant Client’s e-mail, provided by Client during the account registration.
  3. Each request method should have Signature object:

Signature

Name Type Oblig? Description
MerchantCode string * Merchants's code
Sign string * Signature

Each response method has ErrorResponse object:

Name Type Oblig? Description
ErrorCode int * Error code or 0,- if the answer is without errors.
ErrorMessage string * Error description or empty line,- if the answer is without errors.

General card usage scheme is following:

3. Given API methods list

API consists of following methods:

  • UWCFS_OpenAccount
  • UWCFS_OrderCard
  • UWCFS_GetCardList
  • UWCFS_ChangeCardStatus
  • UWCFS_LoadCard
  • UWCFSCheckTransferStatus
  • UWCFS_GetCardStatement
  • UWCFS_GetCardStatementtoEmail
  • UWCFS_GetCardRequestListforDocsUpload
  • UWCFS_AssignCardProduct
  • UWCFS_CheckCardOrders
  • UWCFS_CardFundsDepositQC
  • UWCFS_TransferBetweenCards
  • UWCFS_SendLoadBatchRequest
  • UWCFS_CheckLoadBatchStatus

4. Description of the UWCFS_CheckRegistration method

See description UWCFS_CheckRegistration

5. Description of the UWCFS_OpenAccount method

See description UWCFS_OpenAccount

6. Description of the UWCFS_OrderCard method

The method is intended for ordering card (*1, *2). Card order is possible only after account opening. Only one card of each type (938, 874, 875) and infinite amount of virtual cards (Type 878) can be issued to one Customer.

Customer’s identification is carried out with the help of RUID, transferred by the Agent on Customer’s registration. Account’s identification is carried out with the help of AccountID, transferred by the UWCFS Company as a reply on an account opening request.

Input parameters of the method are:

Name Type Required Example Description
OrderCardRequestBASE Object * See object OrderCardRequestBASE
PersonOccupation String(50) * [A-Za-z0-9 )(]{1,50} Customer’s ocupation
PersonEmail String(100) * [A-Za-z0-9_\-\.@]{1,100} Customer’s E-mail
PersonMobilePhone String(20) * +[0-9]{1,20} Customer’s mobile phone
CardSendingType String(1) * Y/N Method of card delivery (*3)
ExpiryMonthLength String(2) * 1/3/6/12/Empty line Card’s expiration date in Moths (*4)
Reusable String(1) 0/1/Empty line Parameter, showing if the card is of single use type (can be replenished only once) or multiple use type (can be replenished infinitely many times) during card’s expiration date. (*5)
TrCardBalType String(10) * ACC/CARD/Empty line Parameter, showing if Reissued Card Balance should be transferred to the new card or to the Client's account. (*6)
ReissuedCardID String(20) [0-9]{1-20} Parameter shows ID of the Reissued card. (*7)

OrderCardRequestBASE object

Name Type Required Example Description
AccountPerson Object * See object AccountPerson
ProductCode String(5) * QC/VQC Product code. QC – standard prepaid card; VQC – virtual card.
ProductType String(3) * 938/874/875/878 Card type (*8)
ProductCurrency String(3) * [A-Z]{3} Value:USD Card currency from Currency guide (See Appendix 12)
CardEmbossLine1 String(21) * Empty line Parameter is not supported
AmountAvailable UInt32 * 1/0 Funds charge-aff method (*9)
RequestingFreeCard string(1) * 1/0 Request, whrether the card is free (*10)
DiscountCode string(50) [A-Za-z0-9. ]{1,21} Discount code (*11)
SendCardInBatch string(1) * 1/0 Card shipping method: 1- batch, 0 - individually (*12)

Output parameters of the method are (UWCFSCard object)

Name Type Description
CardID UInt32 Cutomer’s card ID
AccountID UInt32 Customer’s account ID
RUID UInt32 Customer’s account RUID
ProductCode String Card Number
ProductType String Card type
EmailShouldBeSent String Sign showing whether the UWCFS’s e-mail is sent in the given card status
Email String Customer’s e-mail
CardNo String Customer’s card number
CardCurrency String Card currency
Balance Decimal Total card balance
AvailableBalance Decimal Available card balance
HoldBalance Decimal Retained card ballance
RequestedCardStatus String Requested card status
ActualCardStatus String Actual card status (*13)
ActivationCode2 String The parameter is not supported
IssueDate String Card issue date
EffectiveDate String Card activation date
ExpiryDate String Card expiration date
CardSendingType String Card shipping method
ExpiryMonthLength String Card expiration date in months

Method’s additional information:

After the successful card issue request, UWCFS Company sends and e-mail to the customer with confirmation of successful card issue request. (see Appendix 2). On Agent’s request UWCFS Company can disable e-mail posting to Customers.

(*1) Customer should be at least 18 years old to order a card.

(*2) Card is delivered to the address, indicated in the document Proof of Address, which should be uploaded to MayzusFS WebService. Proof of Address country should not be in the list of countries banned to card (see Appendix 5).

(*3) Y- shipping with DHL mail and messenger service; N- shipping with standard post. In case of virtual card (Card type 878) the parameter is always equal to N.

(*4) Card’s expiration date is stated only for virtual cards (Product code 878), for other product codes empty line is stated.

(*5) The parameter is stated only for virtual cards (Product code 878), for other product codes empty line is stated.

(*6) The parameter is stated only if new card order is placed instead existing card that is being reissued. The difference between the date, when the new CardOrder request is placed, and the reissued card Expiration Date must be less or equal 30 days.

(*7) During Card Reissuing the old (reissued) card is in Card Active state till the new card is Activated by Client. After that the reissued card is closed automatically.

(*8) Card types which are possible for ordering are discussed with each Agent individually and beforehand. Corresponding card types and product types are described in Appendix 4.

(*9) 0 – Card issue fee will be charged-off from Customer’s account. If there are no enough funds on customer’s account, the error will be returned and card issue request will not be processed; 1- Card issue fee will be charged-off from the Agent’s Company account. Customer’s account balance control is not performed.

(*10) The card is issued free of charge on beforehanf agreement with the Agent.

(*11) Discount code allows to Customer to have a discount on card issue fee. Discount-codes are established and discussed between the UWCFS company and agents individually.

(*12) Batch card delivery is method not a standard option, it is discussed between the UWCFS company and agents individually.

(*13) Card status from the card status guide (see Appendix 6)

7. Description of the UWCFS_GetCardList method

The method is intended for receiving current list of cards with their actual statuses forthe specified Customer with given account. Customer’s identification is carried out with the help of RUID, transferred by the Agent on Customer’s registration. Account’s identification is carried out with the help of AccountID, transferred by the UWCFS Company as a reply on an account opening request.

Input parameters of the method are:

Name Type Required Example Description
UWCFSAccountPersonRequest Object * See object AccountPerson

Output parameters of the method are:

Name Type Description
CardID List of objects of type UWCFSCard See object UWCFSCard

8. Description of the UWCFS_ChangeCardStatus method

The method in intended for changing card’s status (activation / blocking / deblocking)(*1). Customer’s identification is carried out with the help of RUID, transferred by the Agent on Customer’s registration. Account’s identification is carried out with the help of AccountID, transferred by the UWCFS Company as a reply on an account opening request.

Input parameters of the method are:

Name Type Required Example Description
UWCFSAccountPersonRequest Object of type * See object AccountPerson
Action String * [a-zA-Z0-9-]{1,50} Status (*1)
Code1 String * [0-9]{4} The last four digits of a card number
Code2 String * Not in use, necessary to transfer emty line

AccountPersonCardRequest object

Name Type Required Example Description
AccountPerson Object of type AccountPerson * see object AccountPerson
CardID UInt32 * [0-9]{1,10} Customer’s card ID

Output parameters of the method are:

Name Type Description
CardID List of objects of type UWCFSCard See object UWCFSCard

(*1) Action parameter can be of following values: Card Activation Requested, Close Requested. Card’s status change to «Card Activation Requested» is possible only when card has status «Card is Issued and Sent» or «Stopped». Card’s status change to «Stopped» is possible only when card has status «Card Active». Information on current card status can be obtained by requesting UWCFS_ GetCardList method.

Additional method information:

After the successful card status change, the UWCFS Company sends corresponding e-mail to the customer. (see Appendix 2). On Agent’s request UWCFS Company can disable e-mail posting to Customers.

9. Description of the UWCFS_LoadCard method

The method is intended for replenishing card’s funds. Card’s funds can be replenished only in case when card has Card Active status.

Input parameters of the method are:

Name Type Required Example Description
Amount Decimal * Example 12.00 Replenished amount
DocumentID String * [0-9]{1,20} Document’s unique ID in the Agent’s system.
Currency String * [A-Z]{3}USD Replenishment currency from the Currency guide (see Appendix 12)
AmountAvailable String * 1/0 Funds charge-off method (*1)
AccountPersonCardRequest Object * See AccountPersonCardRequest
AutoPayment String * 1/0 Parameter, showing whether payment will be done automatically (1) or not (0) (*3).

Output parameters of the method are:

Name Type Description
DocumentID Uint32 Payment ID in UWCFS system
Status String Payment status in UWCFS system (see Appendix 7).

(*1) 0 – Card issue fee will be charged-off from Customer’s account. If there are no enough funds on customer’s account, the error will be returned and card issue request will not be processed; 1- Card issue fee will be charged-off from the Agent’s Company account. Customer’s account balance control is not performed.

(*2) All replenishment requests are manually confirmed by UWCFS operator. Because of this, card loading can take from 5 minutes up to several hours off time and up to several days on weekends and holidays.

(*3) Payments are carried out automatically 24/7. For automatic payments an increased fee is charged-off. The UWCFS Company establishes limits for automatically carried out payments. Information on these limits can be acquired from the UWCFS company technical.

10. Description of the UWCFSCheckTransferStatus method

See description UWCFSCheckTransferStatus

11. Description of the UWCFS_GetCardStatement method

The method returns customer’s card transaction history..

Input parameters of the method are:

Name Type Required Example Description
AccountPersonCardRequest Object * See AccountPersonCardRequest
DateBeg String* [0-9]{4}-[0-9]{2}-[0-9]{2} Date of the requested transaction begining
DateEnd String* [0-9]{4}-[0-9]{2}-[0-9]{2} Date of requested transaction ending

Output parameters of the method are:

Name Type Description
RequestInfo Object of type UWCFSAccountPersonCardRequest See AccountPersonCardRequest
Statements List of object of type UWCFSCurrencyStatement See object UWCFSCurrencyStatement

12. Description of the UWCFS_GetCardStatementtoEmail method

Using this method, customer can request statement of an account that will be sent to his e-mail, stated during card’s ordering. Incoming and outgoing parameters of this method entirely coincide with incoming and outgoing parameters of UWCFS_GetCardStatement method.

Comments:

As a result of carrying this method out, the customer receives an e-mail from issuing bank. If the Response ErrorCode = 0 object consists of ErrorMessage = '', then it is considered that the order of statement of an account was carried out successfully. Statements object is always returned empty.

13. Description of the UWCFS_GetCardRequestListforDocsUpload method

The method returns list of cards applications, in which the UWCFS Company awaits for documents receipt. The correspondence about given card between the Agent and the UWCFS Company is stated in the Messages field.

Input parameters of the method are: See object Signature

Output parameters of the method are:

Name Type Description
CardRequests List of objects of type CardRequestforDocsUpload See CardRequestforDocsUpload

CardRequestforDocsUpload object

Name Type Description
CardID UInt32 Card ID
DateInserted String UWCFS card issue in request placement data
RUID UInt32 Customer’s RUID in the UWCFS system
ProductCode String Card number
CardCurrency String Card currency
CardStatus String Card status
Messages String Message from the UWCFS Company

14. Description of the UWCFS_AssignCardProduct method

The method is intended for ordering additional cards to the selected Customer. Order of the additional cards is possible only after Customer’s account opening and ordering of one card of one of the possible types.

Only one card of each type (938, 874, 875) and infinite amount of virtual cards (Type 878) can be issued to one Customer.

Customer’s identification is carried out with the help of RUID, transferred by the Agent on Customer’s registration. Account’s identification is carried out with the help of AccountID, transferred by the UWCFS Company as a reply on an account opening request.

Input parameters of the method are:

Name Type Required Example Description
OrderCardRequestBASE Object * See AccountPersonCardRequest
PersonEmail String * [A-Za-z0-9_\-\.@]{1,100} Customer’s e-mail
CardSendingType String * Y/N Card shipping method (*1)
ExpiryMonthLength String(2) * 1/3/6/12/empty line Card expiration date in months (*2)
Reusable String(1) * 0/1/empty line Parameter, showing if the card is of single use type (can be replenished only once) or multiple use type (can be replenished infinitely many times) during card’s expiration date (*3)

Output parameters of the method are:

Name Type Description
CardInformation Object of type UWCFSCard See UWCFSCard

Comments:

(*1) Y- shipping with DHL mail and messenger service; N- shipping with standard post. In case of virtual card (Card type 878) the parameter is always equal to N.

(*2) Card’s expiration date is stated only for virtual cards (Product code 878), for other product codes empty line is stated.

(*3) The parameter is stated only for virtual cards (Product code 878), for other product codes empty line is stated.

15. Description of the UWCFS_CheckCardOrders method

The method is intended for showing available card types, which can be issued or attached to customer’s profile (*1, *2).

Input parameters of the method are:

Name Type Required Example Description
PersonFirstName String * [A-Za-z0-9_\-\.,;:\@\/#\$%\ (conjunction) &\*\(\)\[\]]{1,150} Customer’s name
PersonLastName String * [A-Za-z0-9_\-\.,;:\@\/#\$%\ (conjunction) &\*\(\)\[\]]{1,150} Customer’s surname
PersonDateofBirth String * 938/874/875 Customer’s birth date in yyyy-MM-DD form
PersonEmail String * [A-Za-z0-9_\-\.@]{1,100} Customer’s e-mail

Output parameters of the method are:

Name Type Description
CardCanBeOrdered Int32 Parameter, showing if the Customer already has ordered cards, not rejected and not closed. 1 – Customer doesn’t have any cards yet. Customer can order a card only using UWCFS_OrderCard method; 0 — Customer already has cards. Customer can order an additional card only using UWCFS_AssignCardProduct method.
UWCFSCardProductTypesList List of objects of type UWCFSCardProductTypesList List of the available card types, with short type description, which customer can order. see UWCFSCardProductType.

UWCFSCardProductType object

Name Type Description
ProductTypeCode String see Appendix 4
ProductTypeDescription String Card type description

Comments:

(*1) Only one card of each type (938, 874, 875) and infinite amount of virtual cards (Type 878) can be issued to one Customer. The customer’s identification is carried out with the help of Name, Surname, Date of birth, email.

(*2) The method should be requested before requesting UWCFS_OrderCard or UWCFS_AssignCardProduct methods to make a decision whether the Customer is allowed to order a new card or the Customer already has a card and is only allowed to attach new card to previously ordered card, and to receive the list of available card types for ordering.

16. Description of the UWCFS_CardFundsDepositQC method

The method is intended for replenishing Customer’s account in the UWCFS Company using Quick Card (*1).

Input parameters of the method are:

Name Type Required Example Description
Amount Decimal * [0-9]{1,10}\.[0-9]{2}$ Replenishment amount (*2)
DocumentID String * [0-9]{1,20}$ Document’s unique number in the Merchant’s system
AccountPersonCard Object * AccountPersonCardRequest object
Currency String * USD$ Currency code (*3)
CardNo String * [0-9]{16}$ Customer’s card number
CVV String * [0-9]{3,5}$ Card’s CVV or CVV2 code
ExpireDate String * [0-9]{2}1)$ Card expiration date in the yymm format, with leading zeroes
AmountAvailable String * 0 Constant number, left for compatibility, always equals to 0.
ClientIP String * [0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ Customer’s IP address at the operation execution time.

Output parameters of the method are:

Name Type Description
DocumentID Int32 Document’s unique nuber in the UWCFS system
Status string Document’s status in the UWCFS system

Comments:

(*1) Customer’s account can be replenished only using Quick Cards with Dollars. To replenish account using arbitrary cards the UWCFSCardFundsDeposit service is used, which can be accessed after prior agreement with the UWCFS Company.

(*2) The minimal amount transferred should be larger than the minimal fee for given operation. Customer’s account is charged with transferred amount excluding transfer operation fee.

(*3) Replenishment is possible in Dollars only.

17. Description of the UWCFS_TransferBetweenCards method

The method is intended for transfering funds between Quick Cards (*1).

Input parameters of the method are:

Name Type Required Example Description
UWCFSCardFundsDepositCSCRequest Object * UWCFSCardFundsDepositCSCRequest
ReceiverCardNo String * [0-9]{16}$ Recipient’s card number

Output parameters of the method are:

Name Type Required
DocumentID Int32 Document’s unique number in the UWCFS system
Status string Document’s status in the UWCFS system

Comments:

(*1) Both cards should be registere in the UWCFS sytem.

Method’s additional information:

The minimal amount transferred should be larger than the minimal fee for given operation. Customer’s card is charged with transferred amount excluding transfer operation fee.

Replenishment is possible in Dollars only.

18. Description of the UWCFS_SendLoadBatchRequest method

The method is intended for mass card replenishment (*1).

Input parameters of the method are:

Name Type Required Example Description
MerchantAccountID Int32 * Agent’s account ID in the UWCFS system
FileContent String * Contents of the file with data for loading in Base64 encoding

Output parameters of the method are:

Name Type Required
ResultList List of objects of type UWCFS_CSC_MassCardTransaction_Response_SingleLine
GUID String Package’s unique identifier in the UWCFS system

UWCFS_CSC_MassCardTransaction_Response_SingleLine object

Property name Type Obligatory Description
DocumentID UInt23 * Document ID in the UWCFS system
Status String * Payment status in the UWCFS system (see Appendix 7)
InputRow String * Payment line from the loading file
ErrorCode Int23 * Error code during specific payment processing
ErrorMessage String * Error message during specific payment processing

Comments:

(*1) The method is available for Agents only. Card’s funds replenishment is carried out from Agent’s account in the UWCFS Company to the Customer’s cards.

(*2) The format description of file containing payments to be charged to the cards is shown in Appendix 9.

19. Description of the UWCFS_CheckLoadBatchStatus method

The method is intended for checking payments statuses in the sent batch.

Input parameters of the method are:

Name Type Required Example Description
MerchantAccountID Int32 * Agent’s account ID in the UWCFS system
BatchNumber String * Loading batch number
GUID String * Package’s unique identifier in the UWCFS system

Output parameters of the method are:

Name Type Required
ResultList List of objects of type UWCFS_CSC_MassCardTransaction_Response_SingleLine
Processed Int16 Parameter showing whether the batch was processed or not (0 — not processed, 1 — processed).

Appendices

Appendix 2. Sample e-mail messages sent by the UWCFS Company to its customers

On Agent’s request, the UWCFS Company can disable e-mail posting to Customers.

2.1 UWCFS_OpenAccount

Dear {%NAME%},

We are happy to announce that your UWCFS account has been created.

You can now login to your account with us at https://secure.uwcfs.com/ by using the following login and password.

Your login: {%LOGIN%}

Your password: {%PASSWORD%}

You will be asked to change the password once you have logged in to the Account Management System with UWC Financial Services Ltd. Please, store your password safely and never communicate it to anyone else.

If you have any questions about our company or services, please contact our Customer Support Team at support@uwcfs.com or by calling +44 (0) 208 899 6970. We are available from 8am to 5:30pm GMT Monday to Friday.

Appendix 4. Cards types and product codes compliance

Card type Description of the card type Product code Description of the product code
QC Plastic prepaied MasterCard 938 Quick Card (UWCFS design)
QC Plastic prepaied MasterCard 874 Quick Card (OKPAY design)
QC Plastic prepaied MasterCard 875 Quick Card (LITEFOREX design)
VQC Virtual prepaid card 878 n/a

Appendix 5. Countries guide*, whose residents are banned from card issue

Code Country name
BA Bosnia and Herzegovina
IN India
IR Iran, Islamic Republic of
IL Israel
MK Macedonia, the former Yugoslav Republic of
MM Myanmar
RS Serbia
SO Somalia

* This guide can be changed. The actual guide can be obtained from the UWCFS company technical support.

Appendix 6. Card status guide

Card status Description
Card Request in Process The application for a card is being processed
Card Request is Rejected The application is rejected by UWCFS
Card is Issued and Sent The card is issued and shipped to the Customer
Attention Merchant Costumer’s documents issue
Unavailable Balance Not enough money in the Customer’s account for the card issue
Card Activation Requested Card activation was requested
Card Active The card is activated
Card Close Requested Card blocking was requested
Card Closed The card is closed

Appendix 7. Payment status guide

Card status Description
In process The payment is being processed
Archive The payment is completely processed
Rejected The payment is rejected bu the UWCFS company
STORNO The payment entry was reversed
Unavailable Balance Not enough money in the Customer’s account for the payment to be processed

Appendix 9. File containing payments for mass card loading extension description

Each document, loaded in batch, is presented as a separate line: ClientAccount;CardNo;Amount;DocumentID;AmountAvailable;BatchNumber;

Where: ClientAccount – Customer’s account number in UWCFS,

CardNo – The last four digits of the Customer’s card number,

Amount – Payment amount (without spaces or other symbols, decimal and integer parts separator is the full stop)

DocumentID – The unique loading document’s number in the Agent’s system,

AmountAvailable – The parameter, possessing two values: (0 – funds are charged from Customer’s account in UWCFS, 1 – funds are charged from Merchant’s account)

BatchNumber – Loading batch’s unique number (all of the documents, loaded with one batch, are assigned with batch number).

Appendix 12. General 3-letters ISO currency codes

Currency code Currency name
USD United States Dollar
EUR EURO
GBP Great Britain Pound
RUB Russian Rouble
CHF Swiss Franc
JPY Japanese Yen
CAD Canadian Dollar
AUD Australian Dollar
NZD New Zealand Dollar
CZK Czech Koruna
DKK Danish Krone
HUF Hungary Forint
NOK Norwegian Krone
PLN Polish Zloty
SEK Sweden Kronor
ZAR South African Rand
HRK Croatian kuna
ISK Icelandic krona
RON Romanian new leu
TRY Turkish lira
UAH Ukrainian Hryvnia
1)
0[1-9])|(1[0-2]
uwcfsquickcard.txt · Last modified: 2016/09/26 14:56 by Anatolii Zhiliaev