Advcash - Merchantapi-1.6 en

AdvCash Payment System
Merchant API. Version 1.6
Merchant API
Version 1.6
Merchant API
Version 1.0
1
Table of Contents:
Merchant API
Requirements
Creation of New Merchant API
WSDL File Location
Available Operations
1. validateAccounts. Validation of Account’s Existence.
2. validationSendMoney. Validation of Intrasystem Transfer.
3. validationSendMoneyToAdvcashCard. Validation of Funds Transfer to Advanced
Cash Card.
4. validationSendMoneyToBankCard. Validation of Funds Transfer to External Card
Not Tied to System.
5. validationSendMoneyToECurrency. Validation withdraw funds to a third-party
payment system.
6. validationCurrencyExchange. Validation of Currency Exchange.
7. validationSendMoneyToEmail. Validation of Funds Transfer to Unregistered User
via E-mail.
8. sendMoney. Intrasystem Payment.
9. sendMoneyToAdvcashCard. Transfer of Funds to Advanced Cash Card.
10. sendMoneyToBankCard. Transfer of Funds to External Bank Card.
11. sendMoneyToECurrency. Withdrawals to third-party payment system.
12. currencyExchange. Intrasystem Currency Exchange.
13. sendMoneyToEmail. Transfer of Funds to Unregistered User via E-mail.
14. history. Transaction History.
15. findTransaction. Transaction Search by ID.
16. getBalances. Get Balance per User’s Wallets.
17. validateAccount. Checking matching the first and last name of the user in the
system Advanced Cash with the name and last name of the user in a third-party
system.
18. register. Register a new user.
Enumerated Data Types
ADVCash-cards Types
Currencies
Transaction Statuses
Transaction Names
Ecurrency
Languages
Exceptions
Authentication
Creation of Authentication Token
Change history
2
Merchant API
Requirements
● Protocol HTTPS based operation.
● Blocking API requests through proxy servers.
● HTTP request must contain the correct ‘UserAgent’ HTTP heading and must be
included in all requests.
In the frontend Merchant Tools section, the following Merchant API management
operations are available:
● Create New;
● View and Edit Existing;
● Delete.
All changes must be confirmed with the password from the current settings of the
application software package (ASP).
Creation of New Merchant API

● API Name is any unique (within the given account) word or phrase (mandatory)
● Requesting IP Address is the IP address from which the client (client application) will
contact the Advanced Cash application (optional, but recommended)
● Security Word is a combination of Latin letters and numbers with a length of at least 6
characters (mandatory)
● Enabled/Disabled is the On/Off status of Merchant API
● Operation Selection (API Operations) (Not available if not included)
1. Check Accounts. Validation of account availability.
2. See Balance per Wallet. Getting balance for wallets.
3. Find Transaction. Searching transactions by name.
4. Transaction History. Getting history of transactions.
5. Make Transaction. Carrying out transactions.
● Wallet Limit Selection. List of all wallets with a filed for entering a limit. By default,
it is set at ‘0’ for all wallets.
● Password for the current ASP.
3
WSDL File Location

https://wallet.advcash.com:8443/wsm/merchantWebService?wsdl
Available Operations
1. validateAccounts. Validation of Account’s Existence.
Request Parameters
Parameter Internal Parameter Type Description
arg0 apiName String API name in Advanced Cash system
authenticationToken String Generated token (Authentication section)
accountEmail String Email of the user that owns the API
arg1 String Email of the user in Advanced Cash system to validate
existence
Successful Response Parameters

return accountEmail String Email of the user in Advanced Cash system
present Boolean Indicator of user’s existence in Advanced Cash system
Example of Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsm="http://wsm.advcash/">
<soapenv:Header/>
<soapenv:Body>
<wsm:validateAccounts>
<arg0>
<apiName>api_name</apiName>
<authenticationToken>token</authenticationToken>
<accountEmail>name@example.com</accountEmail>
</arg0>
<arg1>name@example.com</arg1>
</wsm:validateAccounts>
</soapenv:Body>
</soapenv:Envelope>
Example of Successful Response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:validateAccountsResponse xmlns:ns2="http://wsm.advcash/">
<return>
<present>true</present>
4
</return>
<return>
<present>true</present>
</return>
<return>
<present>false</present>
</return>
<return>
</return>
<return>
</return>
</ns2:validateAccountsResponse>
</soap:Body>
</soap:Envelope>
5
2. validationSendMoney. Validation of Intrasystem Transfer.
Request Parameter
arg1 amount Double Transaction amount (accuracy – up to two digits after
decimal point)
currency Enumeration Transfer currency (3 characters ISO 4217, Currencies
section)
email String Recipient’s email
note String Note to transaction
savePaymentTemplate Boolean Indicator of saving the current payment template
If the validation of the expected payment is successful, the response from the server
will contain a blank message. If the validation is not successful, a message with an
error contained in its body will be returned.
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:validationSendMoney>
<arg0>
</arg0>
<arg1>
<amount>1.00</amount>
<currency>USD</currency>
<email>name@example.com</email>
<note>Some note</note>
<savePaymentTemplate>false</savePaymentTemplate>
</arg1>
</wsm:validationSendMoney>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:validationSendMoneyResponse xmlns:ns2="http://wsm.advcash/"/>
</soap:Body>
</soap:Envelope>
6
3. validationSendMoneyToAdvcashCard. Validation of Funds Transfer to Advanced

Cash Card.
Request Parameters
rg0 apiName String API name in Advanced Cash system
decimal point)
currency Enumerati Transfer currency (3 characters ISO 4217, Currencies
on section)
email String Email of the user that owns the card
cardType Enumerati Card type which will be used for the transfer of funds
on (ADVCash-cards Types section)
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:validationSendMoneyToAdvcashCard>
<arg0>
</arg0>
<arg1>
<cardType>PLASTIC</cardType>
</arg1>
</wsm:validationSendMoneyToAdvcashCard>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:validationSendMoneyToAdvcashCardResponse xmlns:ns2="http://wsm.advcash/"/>
</soap:Body>
</soap:Envelope>
7
4. validationSendMoneyToBankCard. Validation of Funds Transfer to External Card

Not Tied to System.
Request Parameters
decimal point)
currency Enumerati Transfer currency (3 characters ISO 4217, Currencies section)
on
cardNumber String External card number for finds withdrawal
expiryMonth Numeric Two digits that signify the month of the card’s expiration
date (e.g. 09 for September)
expiryYear Numeric Two last digits of the year of the card’s expiration date
(e.g. 17 for year 2017)
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:validationSendMoneyToBankCard>
<arg0>
</arg0>
<arg1>
<cardNumber>4149605912035536</cardNumber>
<expiryMonth>08</expiryMonth>
<expiryYear>17</expiryYear>
</arg1>
</wsm:validationSendMoneyToBankCard>
</soapenv:Body>
</soapenv:Envelope>
8

<soap:Body>
<ns2:validationSendMoneyToBankCardResponse xmlns:ns2="http://wsm.advcash/"/>
</soap:Body>
</soap:Envelope>
9
5. validationSendMoneyToEcurrency. Validation of Withdrawal ot a third-party

payment system.
Request Parameters
decimal point)
currency Enumerati Currency of transaction (3 characters ISO 4217, Currencies
on section)
ecurrency Enumerati Ecurrency (Ecurrency chapter)
on
receiver String ID or wallet of the recipient in the third-party payment
system
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:validationSendMoneyToEcurrency>
<arg0>
</arg0>
<arg1>
<currency>RUR</currency>
<ecurrency>YANDEX_MONEY</ecurrency>
<receiver>410022528972199</receiver>
</arg1>
</wsm:validationSendMoneyToEcurrency>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2: validationSendMoneyToEcurrency xmlns:ns2="http://wsm.advcash/"/>
</soap:Body>
</soap:Envelope>
10
6. validationCurrencyExchange. Validation of Currency Exchange.
Request Parameters
arg1 from Enumerati Outgoing currency (3 characters ISO 4217, Currencies
on section)
to Enumerati Incoming currency (3 characters ISO 4217, Currencies
on section)
action Enumerati Takes 2 values «BUY» and «SELL»
on «BUY» - will be bought the «amount» in currency «to»
«SELL» - will be sold the «amount» in currency «from»
amount Double Transaction amount (accuracy – up to two digits after
decimal point)
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:validationCurrencyExchange>
<arg0>
</arg0>
<arg1>
<from>USD</from>
<to>EUR</to>
<action>SELL</action>
</arg1>
</wsm:validationCurrencyExchange>
</soapenv:Body>
</soapenv:Envelope>
11

<soap:Body>
<ns2:validationCurrencyExchangeResponse xmlns:ns2="http://wsm.advcash/"/>
</soap:Body>
</soap:Envelope>
12
7. validationSendMoneyToEmail. Validation of Funds Transfer to Unregistered User

via E-mail.
Request Parameters
decimal point)
currency String Transaction currency (3 characters ISO 4217, Currencies
section)
email String E-mail address of the payment recipient unregistered in
Advanced Cash system (Immediately after registration in
Advanced Cash system, user will receive funds transfer)
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:validationSendMoneyToEmail>
<arg0>
</arg0>
<arg1>
</arg1>
</wsm:validationSendMoneyToEmail>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:validationSendMoneyToEmailResponse xmlns:ns2="http://wsm.advcash/"/>
</soap:Body>
</soap:Envelope>
13
8. sendMoney. Intrasystem Payment.
Request Parameters
decimal point)
currency Enumeration Transfer currency (3 characters ISO 4217, Currencies
section)
email String Recipient’s email

return String ID совершенной транзакции
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:sendMoney>
<arg0>
</arg0>
<arg1>
</arg1>
</wsm:sendMoney>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:sendMoneyResponse xmlns:ns2="http://wsm.advcash/">
<return>d1062eba-29b7-456c-b6ad-2ca734af4924</return>
</ns2:sendMoneyResponse>
</soap:Body>
</soap:Envelope>
14
9. sendMoneyToAdvcashCard. Transfer of Funds to Advanced Cash Card.
Request Parameters
decimal point)
on section)
email String Email of the user that owns the card
cardType Enumerati Card type which will be used for the transfer of funds
on (ADVCash-cards Types section)

return String Transaction ID
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:sendMoneyToAdvcashCard>
<arg0>
</arg0>
<arg1>
<cardType>PLASTIC</cardType>
</arg1>
</wsm:sendMoneyToAdvcashCard>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:sendMoneyToAdvcashCardResponse xmlns:ns2="http://wsm.advcash/">
<return>7514204c-d4fe-4617-ac79-241703443946</return>
</ns2:sendMoneyToAdvcashCardResponse>
</soap:Body>
</soap:Envelope>
15
10. sendMoneyToBankCard. Transfer of Funds to External Bank Card.
Request Parameters
decimal point)
on section)
cardNumber String External card number for finds withdrawal
expiryMonth Numeric Two digits that signify the month of the card’s expiration
date (e.g. 09 for September)
expiryYear Numeric Two last digits of the year of the card’s expiration date
(e.g. 17 for year 2017)

Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:sendMoneyToBankCard>
<arg0>
</arg0>
<arg1>
<cardNumber>4149605912035536</cardNumber>
<expiryMonth>08</expiryMonth>
<expiryYear>17</expiryYear>
</arg1>
</wsm:sendMoneyToBankCard>
</soapenv:Body>
</soapenv:Envelope>
16

<soap:Body>
<ns2:sendMoneyToBankCardResponse xmlns:ns2="http://wsm.advcash/">
<return>20931ce4-f4c9-4cc5-84f7-f7efb38c939c</return>
</ns2:sendMoneyToBankCardResponse>
</soap:Body>
</soap:Envelope>
17
11. sendMoneyToEcurrency. Withdraw to third-party payment system.

Request Parameters
arg1 amount Double Transaction amount (accuracy – up to two digits after decimal
point)
currency Enumerat Currency of transaction (3 characters ISO 4217, Currencies
ion section)
ecurrency Enumerat Ecurrency (Ecurrency chapter)
ion
receiver String ID or wallet of the recipient in the third-party payment
system
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:sendMoneyToEcurrency>
<arg0>
</arg0>
<arg1>
<currency>RUR</currency>
<ecurrency>YANDEX_MONEY</ecurrency>
<receiver>410022528972199</receiver>
</arg1>
</wsm:sendMoneyToEcurrency>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2: sendMoneyToEcurrency xmlns:ns2="http://wsm.advcash/">
<return>d28a6da7-451d-41c4-93f8-cd0084c72f96</return>
</ns2:sendMoneyToEcurrency>
</soap:Body>
</soap:Envelope>
18
12. currencyExchange. Intrasystem Currency Exchange.
Request Parameters
arg1 from Enumerati Outgoing currency (3 characters ISO 4217, Currencies
on section)
to Enumerati Incoming currency (3 characters ISO 4217, Currencies
on section)
action Enumerati Takes 2 values «BUY» and «SELL»
on «BUY» - will be bought the «amount» in currency «to»
«SELL» - will be sold the «amount» in currency «from»
decimal point)
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:currencyExchange>
<arg0>
</arg0>
<arg1>
<from>USD</from>
<to>EUR</to>
<action>SELL</action>
</arg1>
</wsm:currencyExchange>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:currencyExchangeResponse xmlns:ns2="http://wsm.advcash/">
<return>1575948b-6ead-426f-8ecf-ee7ffaa3969c</return>
</ns2:currencyExchangeResponse>
</soap:Body>
</soap:Envelope>
19
13. sendMoneyToEmail. Transfer of Funds to Unregistered User via E-mail.
Request Parameters
decimal point)
currency String Transaction currency (3 characters ISO 4217, Currencies
section)
email String E-mail address of the payment recipient unregistered in
Advanced Cash system (Immediately after registration in
Advanced Cash system, user will receive funds transfer)

Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:sendMoneyToEmail>
<arg0>
</arg0>
<arg1>
</arg1>
</wsm:sendMoneyToEmail>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:sendMoneyToEmailResponse xmlns:ns2="http://wsm.advcash/">
<return>8fa3a69a-c792-4f77-ba06-c880cd836ebc</return>
</ns2:sendMoneyToEmailResponse>
</soap:Body>
</soap:Envelope>
20
14. history. Transaction History.

Request Parameters
arg1 accountName Double Transaction amount (accuracy – up to two digits after
decimal point)
startTimeFrom Date&Time Start date for transactions to be selected (template -
yyyy-MM-dd'T'HH:mm:ss)
startTimeTo Date&Time End date for transactions to be selected (template -
yyyy-MM-dd'T'HH:mm:ss)
transactionName Enumeration Transaction name (Transaction Names section)
transactionStatus Enumeration Transaction status (Transaction Statuses section)
updatedFrom Date&Time Start date for status update for transactions to be
selected (template - yyyy-MM-dd'T'HH:mm:ss)
updatedTo Date&Time Start date for status update for transactions to be
selected (template - yyyy-MM-dd'T'HH:mm:ss)
walletId String Sender’s wallet (optional parameter)

return id String Transaction ID
activityLevel Integer Payment initiator’s system activity level
decimal point)
amountInUSD Double Transaction amount in USD (accuracy – up to two digits
after decimal point)
fullCommission Double Current transaction commission fee (accuracy – up to
two digits after decimal point)
startTime Date Transaction creation date (template - yyyy-MM-
dd'T'HH:mm:ss'.'SZ)
status Enumeration Transaction status (Transaction Statuses section)
walletDestId String Recipient’s wallet

walletSrcId String Sender’s wallet
The “walletDestId” and “walletSrcId” fields are not provided in all transaction types
(See “Example of Successful Response” below). “walletSrcId” is used in withdrawal
transactions and intrasystem transactions. “walletDestId” is used in deposit
transactions and intrasystem transactions.
Example of Request:
21
<soapenv:Header/>
<soapenv:Body>
<wsm:history>
<arg0>
</arg0>
<arg1>
<accountName>name@example.com</accountName>
<startTimeFrom>2011-01-01T00:00:00</startTimeFrom>
<startTimeTo>2014-03-25T12:17:00</startTimeTo>
<transactionName>ALL</transactionName>
<transactionStatus>COMPLETED</transactionStatus>
<updatedFrom>2011-01-01T00:00:00</updatedFrom>
<updatedTo>2014-03-25T12:17:00</updatedTo>
<walletId>U993960083199</walletId>
</arg1>
</wsm:history>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:historyResponse xmlns:ns2="http://wsm.advcash/">
<return>
<id>1575948b-6ead-426f-8ecf-ee7ffaa3969c</id>
<activityLevel>0</activityLevel>
<amountInUSD>6.97</amountInUSD>
<fullCommission>0.07</fullCommission>
<startTime>2014-03-25T10:21:59.901+01:00</startTime>
<status>COMPLETED</status>
<transactionName>CURRENCY_EXCHANGE</transactionName>
<walletDestId>E060990630681</walletDestId>
<walletSrcId>U993960083199</walletSrcId>
</return>
<return>
<id>20931ce4-f4c9-4cc5-84f7-f7efb38c939c</id>
<transactionName>BANK_CARD_TRANSFER</transactionName>
</return>
<return>
<id>7514204c-d4fe-4617-ac79-241703443946</id>
<transactionName>ADVCASH_CARD_TRANSFER</transactionName>
22
</return>
<return>
<id>d1062eba-29b7-456c-b6ad-2ca734af4924</id>
<comment>Some comment</comment>
<transactionName>INNER_SYSTEM</transactionName>
<walletDestId>U000000000000</walletDestId>
</return>
<return>
<id>19a414cb-6c6b-4932-8244-394607d44914</id>
<comment/>
<transactionName>CHECK_DEPOSIT</transactionName>
</return>
<return>
<id>4db253ce-2fa4-4a2c-b57b-8ac786cb2f42</id>
<transactionName>ADVCASH_CARD_TRANSFER</transactionName>
</return>
<return>
<id>10311368-d5c9-46ca-945a-63bc6b2069ae</id>
<comment/>
<walletSrcId>E814009369319</walletSrcId>
</return>
<return>
<id>79789306-ed1b-4def-a2b4-359eab9e895f</id>
<comment>This is transfer inner transaction</comment>
23
</return>
<return>
<id>44bfaf6d-9028-4d9c-8e4b-5129f98ec250</id>
<comment/>
</return>
<return>
<id>8c75ba94-8042-45f9-ac2d-5ed3781ea9d2</id>
<comment/>
</return>
<return>
<id>c4d093ee-6e2c-498f-b6e2-994f5ce77e64</id>
<comment/>
</return>
<return>
<id>e5383553-f66c-4073-b81d-86e7c3756cdb</id>
<comment/>
</return>
</ns2:historyResponse>
</soap:Body>
</soap:Envelope>
24
15. findTransaction. Transaction Search by ID.
Request Parameters
arg1 String Transaction ID

return id String Transaction ID
activityLevel Integer Payment initiator’s system activity level
decimal point)
amountInUSD Double Transaction amount in USD (accuracy – up to two digits
after decimal point)
fullCommission Double Current transaction commission fee (accuracy – up to
two digits after decimal point)
startTime Date Transaction creation date (template - yyyy-MM-
dd'T'HH:mm:ss'.'SZ)
status Enumeration Transaction status (Transaction Statuses section)
walletDestId String Recipient’s wallet

walletSrcId String Sender’s wallet
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:findTransaction>
<arg0>
</arg0>
<arg1>e5383553-f66c-4073-b81d-86e7c3756cdb</arg1>
</wsm:findTransaction>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:findTransactionResponse xmlns:ns2="http://wsm.advcash/">
<return>
<id>e5383553-f66c-4073-b81d-86e7c3756cdb</id>
25
<comment/>
</return>
</ns2:findTransactionResponse>
</soap:Body>
</soap:Envelope>
26
16. getBalances. Get Balance per User’s Wallets.
Request Parameters

return amount Double Wallet amount (accuracy – up to two digits after decimal
point)
id String Walled ID
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:getBalances>
<arg0>
</arg0>
</wsm:getBalances>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:getBalancesResponse xmlns:ns2="http://wsm.advcash/">
<return>
<id>U993960083199</id>
</return>
<return>
<id>E060990630681</id>
</return>
<return>
<amount>0</amount>
<id>R375997875321</id>
</return>
<return>
<amount>0</amount>
<id>G112983230977</id>
</return>
</ns2:getBalancesResponse>
</soap:Body>
</soap:Envelope>
27
17. validateAccount. Checking matching the first and last name of the user in the
Advanced Cash system with the name and last name in a third-party system.
Request Parameters
arg1 email String Email of the user in the Advanced Cash, for which will be
reconciling the first and last name (required, if not specified
walletId)
walletId String Wallet of the user in the Advanced Cash, for which will be
reconciling the first and last name (required, if not specified
email)
firstName String The name of the user in third-party system to verify with the
name of the user in the Advanced Cash
lastName String The last name of the user in third-party system to verify with
the last name of the user in the Advanced Cash

return firstNameMatchingPercent Double Percentage of matches the user name of Advanced Cash with
age user name in third-party system (takes values from 0 to 100)
lastNameMatchingPercenta Double Percentage of matches the user last name of Advanced Cash
ge with user last name in third-party system (takes values from
0 to 100)
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:validateAccount>
<arg0>
</arg0>
<arg1>
<walletId>U000000000000</walletId>
<firstName>John</firstName>
<lastName>Smith</lastName>
</arg1>
</wsm:validateAccount>
</soapenv:Body>
</soapenv:Envelope>
28

<soap:Body>
<ns2:validateAccountResponse xmlns:ns2="http://wsm.advcash/">
<return>
<firstNameMatchingPercentage>0.75341</firstNameMatchingPercentage>
<lastNameMatchingPercentage>1</lastNameMatchingPercentage>
</return>
</ns2:validateAccountResponse>
</soap:Body>
</soap:Envelope>
29
18. register. Register a new user.
Request Parameters
arg1 email String User's email
firstName String User's first name
lastName String User's last name
language Enumera User's language (Languages section)
tion
ip String User's IP-address
If the registration of the user is successful, the response from the server will contain a
blank message. If the registration is not successful, a message with an error contained
in its body will be returned.
Example of Request:
<soapenv:Header/>
<soapenv:Body>
<wsm:register>
<arg0>
</arg0>
<arg1>
<firstName>John</firstName>
<lastName>Smith</lastName>
<language>en</language>
<ip>*.*.*.*</ip>
</arg1>
</wsm:register>
</soapenv:Body>
</soapenv:Envelope>

<soap:Body>
<ns2:registerResponse xmlns:ns2="http://wsm.advcash/" />
</soap:Body>
</soap:Envelope>
30
Enumerated Data Types
ADVCash-cards Types
Parameter Possible Values Description
cardType VIRTUAL Virtual card
PLASTIC Plastic card
31
Currencies
transferCurrency USD US Dollar
EUR Euro
RUR Russian Ruble
GBP Pound Sterling
32
Transaction Statuses
transactionStatus PENDING Transaction processing is pending.
PROCESS Transaction is being processed.
COMPLETED Transaction is completed.
CANCELED Transaction is cancelled.
CONFIRMED Transaction is confirmed.
33
Transaction Names
transactionName ALL All transactions regardless of their type
CHECK_DEPOSIT Funds deposit by bank check
WIRE_TRANSFER_DEPOSIT Funds deposit from bank account
WIRE_TRANSFER_WITHDRAW Funds withdrawal to bank account
INNER_SYSTEM Intrasystem funds transfer
CURRENCY_EXCHANGE Currency exchange within account
BANK_CARD_TRANSFER Funds withdrawal to external bank card
ADVCASH_CARD_TRANSFER Funds transfer to Advanced Cash card
EXTERNAL_SYSTEM_DEPOSIT Deposit funds through third-party system
EXTERNAL_SYSTEM_WITHDRAWAL Withdrawal through third-party system
REPAYMENT Funds repayment
34
Ecurrency
ecurrency BITCOIN Withdrawal to BTC
OKPAY OkPay payment system
PAXUM Paxum payment system
PAYEER Payeer payment system
YANDEX_MONEY Yandex.Money payment system
35
Languages
Параметр Возможные значения Описание
language en English
ru Русский
36
Exceptions
exception AccessDeniedException Access denied.
AlreadyExistException The object already exists.
ApiException Exception of the third-party payment system.
AttemptsHaveEndedException The number of attempts exceeds the allowed
maximum.
BadParametersException Incorrect set of parameters
BadFormatAmountException The payment amount is entered incorrectly.
EmailAlreadyExistException A user with this email address is already registered in
the Advanced Cash system.
ExchangeCurrencyException Currency exchange error
IpAddressIsWrongException Incorrect IP address
LimitPerMonthException The monthly transaction amount limit is exceeded.
LimitPerDayException The daily transaction amount limit is exceeded.
LimitPerTransactionException The transaction limit is exceeded.
NotEnoughMoneyException The funds are insufficient to make a payment.
PasswordExpiredException Expired password
PasswordIncorrectException Incorrect password
RecipientDoesNotExistException Payment recipient was not found.
SenderDoesNotExistException Payment sender was not found.
TooManyAttemptsException The maximum number of attempts is exceeded.
TooManyWalletsException The maximum number of wallets is exceeded.
UnsupportedTransaction This transaction type or transaction name is not
supported.
UserBlockedException The user is blocked and can not receive/make
payments.
UserDoesNotExistException Such user does not exist in the Advanced Cash system.
VeryBigAmountException The maximum payment amount limit is exceeded.
WalletCurrencyIncorrectException The currency entered does not match the wallet’s
currency.
WalletDoesNotExist Such wallet does not exist.
WrongParametersException Incorrect request parameters
WrongEmailException Incorrect email address format
IpInBlackListException This IP address is blacklisted, and the user can not
carry out any operations from this IP address.
CardDoesNotExistException Such card does not exist.
CardIsNotActiveException The card with this number is not active.
CardNumberIsNotValidException Incorrect card number format
37
Authentication
All requests sent to the API must contain the information that will allow the server to
verify the authenticity of the user sending a request. This request will contain the
Account Email and other information that will help the server identify the user
sending a request. All requests from the server to the API must contain the following
authentication details:
● API Name;
● Authentication Token. This parameter consists of a hashed text formed by combining
the security word and the date UTC.
● Account Email.
38
Creation of Authentication Token

You must create an authentication token based on the following algorithm:
1. Form a text by combining the following parameters: API Password:Date UTC in
YYYYMMDD format:Time UTC in HH format (only hours, not minutes).
2. Hash this text using the SHA256 algorithm.
For example, API Password: “P@ssw0rd”, date UTC: “2007.02.25 14:55” (24h format)
Text based on the parameters’ combination: “P@ssw0rd:20070225:14”
Hash SHA256 for this text:
CA5EE568D588145E5302B68DCF57B84E9E58D86EDCE287A2C5DC45435C364BAB
39
Change history
Version Changes
1.0 -
1.1 Removed getWireTransferRequiredData method.
1.2 Removed «destCurrency», «expirlyMonth», «expirlyYear», «savePaymentTemplate»
parameters from sendMoneyToAdvcashCard and vakidateAdvancedCardTransfer methods
Renamed «destCurrency» parameter to «transferCurrency»
1.3 Added method «validateAccount»
1.4 Added methods «validationSendMoneyToEcurrency», «sendMoneyToEcurrency»
1.5 Renamed «SystemAccountName» parameter to «accountEmail»
1.6 Removed methods «validateTransfer», «validateAdvcashCardTransfer»,
«validateBankCardTransfer», «validateWithdrawalThroughExternalPaymentSystem»,
«validateCurrencyExchange», «validateEmailTransfer», «makeTransfer»,
«transferAdvcashCard», «transferBankCard», «withdrawalThroughExternalPaymentSystem»,
«makeCurrencyExchange», «emailTransfer»
Added methods «validationSendMoney», «validationSendMoneyToAdvcashCard»,
«validationSendMoneyToBankCard», «validationSendMoneyToEcurrency»,
«validationCurrencyExchange», «validationSendMoneyToEmail», «sendMoney»,
«sendMoneyToAdvcashCard», «sendMoneyToBankCard», «sendMoneyToEcurrency»,
«currencyExchange», «sendMoneyToEmail», «register»
40

Advcash - Merchantapi-1.6 en

Uploaded by

Document Informationclick to expand document information

Copyright:

Available Formats

Advcash - Merchantapi-1.6 en

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Advcash - Merchantapi-1.6 en

Uploaded by

Copyright:

Available Formats

AdvCash Payment System

Merchant API. Version 1.6

Creation of New Merchant API

WSDL File Location

1. validateAccounts. Validation of Account’s Existence.

Successful Response Parameters

Example of Successful Response:

2. validationSendMoney. Validation of Intrasystem Transfer.

Example of Successful Response:

3. validationSendMoneyToAdvcashCard. Validation of Funds Transfer to Advanced

Example of Successful Response:

4. validationSendMoneyToBankCard. Validation of Funds Transfer to External Card

Example of Successful Response:

5. validationSendMoneyToEcurrency. Validation of Withdrawal ot a third-party

Example of Successful Response:

6. validationCurrencyExchange. Validation of Currency Exchange.

Example of Successful Response:

7. validationSendMoneyToEmail. Validation of Funds Transfer to Unregistered User

Example of Successful Response:

8. sendMoney. Intrasystem Payment.

Successful Response Parameters

Example of Successful Response:

9. sendMoneyToAdvcashCard. Transfer of Funds to Advanced Cash Card.

Successful Response Parameters

Example of Successful Response:

10. sendMoneyToBankCard. Transfer of Funds to External Bank Card.

Successful Response Parameters

Example of Successful Response:

11. sendMoneyToEcurrency. Withdraw to third-party payment system.

Example of Successful Response:

12. currencyExchange. Intrasystem Currency Exchange.

Example of Successful Response:

13. sendMoneyToEmail. Transfer of Funds to Unregistered User via E-mail.

Successful Response Parameters

Example of Successful Response:

14. history. Transaction History.

Successful Response Parameters

walletDestId String Recipient’s wallet

Example of Successful Response:

15. findTransaction. Transaction Search by ID.

Successful Response Parameters

walletDestId String Recipient’s wallet

Example of Successful Response:

16. getBalances. Get Balance per User’s Wallets.

Successful Response Parameters

Example of Successful Response:

Successful Response Parameters

Example of Successful Response:

18. register. Register a new user.

Example of Successful Response:

Enumerated Data Types

Creation of Authentication Token

You might also like