EN / ru

Processing Automatic Interfaces

Processing Automatic Interfaces

General information

Request methods

Requests authentication

Response format

Error codes

Methods of checking payment status

Checking payment status by Payment ID

Checking payment status by invoice ID

Receiving payments list (transaction file)

Information Transfer Guidelines for Refunds

Introduction

Refund from web office

Automatic refunds

Receiving refunds list

Receiving documents list

Downloading document

General information

Request methods

Processing automactic interfaces are used via HTTP GET or POST requests to the specific backoffice URLs. URL general format looks like http://psp.wmtransfer.com/partners/rest/xxx, where xxx is the operation name.

Each request GET- or POST-parameter should contain information specific to the request.

Requests authentication

All requests should be performed by the users with the login method "Automatic access". Users should have a role of Operationist (receiving payment status and payments list) or Financial staff (Operationist + refund + refunds list). Each request must contain the following fields: login, nonce и hash. These fields are used for authentication in the following way:

  • login is the login for the automatic interfaces issued to you by the support team (tech@paymaster.ru). This login cannot be used for the interactive logon to the backoffice, it can be used for the REST request authentication only.
  • password is the password for the automatic interfaces. IT’S NEVER PASSED OVER NETWORK! This password is used only for hash generation.
  • nonce is a one-time request ticket. It is a random string with a maximum length of 255 symbols not containing ‘;’. You should generate a new one-time ticket for each request.
  • hash is the hash of the request parameters. The description of each operation contains the list of fields to be hashed. Fields values are concatenated using semicolons as separators. Then you need to compute a SHA1 hash of the resulted UTF-8 string. The hash itself is base64 encoded. PHP example: $hash = base64_encode(sha1($str, true)), where $str - is the concatenation string.

When the hash is generated incorrectly you receive the error code -7 (see Error codes)

Please note that in case of GET requests each parameter must be url-escaped!

Response format

Processing interfaces always respond with HTTP status 200. If another HTTP status occurs then there was an error parsing the request.

Processing interfaces send response in JSON format. Response example:

{"ErrorCode":0,"Payment":{"PaymentID":1,"SiteInvoiceID":"12345",
"SiteID":1,"CurrencyCode":"USD","Amount":33,"PaymentSystemID":
0,"PaymentCurrencyCode":null,"PaymentAmount":0,"State":"COMPLETE",
"Purpose":null,"IsTestPayment":false,"UserPhoneNumber":"79161234567",
"UserIdentifier":null,"LastUpdate":"\/Date(1369231732745)\/","LastUpdateTime":
"2013-05-22T18:08:52"}}

If the request contains the parameter ‘xml’ with the value ‘1’ then the response will be in XML format: 

<RestController.RestResponse xmlns="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Controllers"xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ErrorCode>
        0
    </ErrorCode>
    <Response xmlns:a="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Models.REST" i:type="a:RestPaymentInfo">
        <a:Amount>
            33
        </a:Amount>
        <a:CurrencyCode>
            USD
        </a:CurrencyCode>
        <a:IsTestPayment>
            false
        </a:IsTestPayment>
        <a:LastUpdate>
            2013-05-22T17:22:34.2208127+04:00
        </a:LastUpdate>
        <a:PaymentAmount>
            0
        </a:PaymentAmount>
        <a:PaymentCurrencyCode i:nil="true"/>
        <a:PaymentID>
            1
        </a:PaymentID>
        <a:PaymentSystemID>
            0
        </a:PaymentSystemID>
        <a:Purpose i:nil="true"/>
        <a:SiteID>
            1
        </a:SiteID>
        <a:SiteInvoiceID>
            12345
        </a:SiteInvoiceID>
        <a:State>
            COMPLETE
        </a:State>
        <a:UserIdentifier i:nil="true"/>
        <a:UserPhoneNumber>
            79161234567
        </a:UserPhoneNumber>
    </Response>
</RestController.RestResponse>

Each response contains the numeric field ErrorCode (see. Error codes). If there was no error  (ErrorCode=0), then the next field is the response body.

Attention: Response parameters lists can be extended (but not removed) following the changes to this document. The response handling should be implemented considering the possibility of introducing the new fields.

Error codes

Possible values of ErrorCode in the Processing response:

-1

Unknown error. If the error persists please consult support.

-2

Network error. If the error persists please consult support.

-6

Access denied. The specified login has no access to the requested information.

-7

Invalid request signature. The hash is generated incorrectly.

-13

Payment can not be found by InvoiceID

-14

Duplicate request with the same nonce

-18

Incorrect value of the sum. (In case of refunds is meant value "amount")

Methods of checking payment status

Checking payment status by Payment ID

The following REST interface used for checking payment status by Payment ID:

  • paymentID: Processing payment ID (LMI_SYS_PAYMENT_ID)
  • Parameters used for hashing: login;password;nonce;paymentID
  • Response parameters:
  • State - payment state. Possible values:
  • INITIATED
  • PROCESSING
  • COMPLETE
  • CANCELLED
  • Amount - payment amount
  • CurrencyCode -  three-letter currency code 
  • IsTestPayment - a sign of test payment (payment is made in test or production mode)
  • LastUpdate (LastUpdateTime for JSON) - the last status update time. To completed payments - the completion time
  • PaymentAmount - paid amount
  • PaymentCurrencyCode - payment currency code
  • PaymentID - Processing payment ID
  • PaymentSystemID - payment system ID
  • Purpose - payment description
  • SiteID - Merchant site ID
  • SiteInvoiceID - Invoice ID (LMI_PAYMENT_NO)
  • UserIdentifier - user ID in payment system
  • UserPhoneNumber - payer phone number.

Request example: 

https://psp.wmtransfer.com/partners/rest/getpayment?login=TestLogin&nonce=ttt&paymentid=1&hash=123

Response example:

{"ErrorCode":0,"Payment":{"PaymentID":1,"SiteInvoiceID":"12345",
"SiteID":1,"CurrencyCode":"USD","Amount":33,"PaymentSystemID":
0,"PaymentCurrencyCode":null,"PaymentAmount":0,"State":"COMPLETE",
"Purpose":null,"IsTestPayment":false,"UserPhoneNumber":"79161234567",
"UserIdentifier":null,"LastUpdate":"\/Date(1369231732745)\/","LastUpdateTime":
"2013-05-22T18:08:52"}}

Request example: 

https://psp.wmtransfer.com/partners/rest/getpayment?login=TestLogin&nonce=ttt&paymentid=1&hash=123&xml=1

Response example:

<RestController.RestResponse xmlns="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Controllers"xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ErrorCode>
        0
    </ErrorCode>
    <Response xmlns:a="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Models.REST" i:type="a:RestPaymentInfo">
        <a:Amount>
            33
        </a:Amount>
        <a:CurrencyCode>
            USD
        </a:CurrencyCode>
        <a:IsTestPayment>
            false
        </a:IsTestPayment>
        <a:LastUpdate>
            2013-05-22T18:01:59.1166495+04:00
        </a:LastUpdate>
        <a:PaymentAmount>
            0
        </a:PaymentAmount>
        <a:PaymentCurrencyCode i:nil="true"/>
        <a:PaymentID>
            1
        </a:PaymentID>
        <a:PaymentSystemID>
            0
        </a:PaymentSystemID>
        <a:Purpose i:nil="true"/>
        <a:SiteID>
            1
        </a:SiteID>
        <a:SiteInvoiceID>
            12345
        </a:SiteInvoiceID>
        <a:State>
            COMPLETE
        </a:State>
        <a:UserIdentifier i:nil="true"/>
        <a:UserPhoneNumber>
            79161234567
        </a:UserPhoneNumber>
    </Response>
</RestController.RestResponse>

Checking payment status by invoice ID

The following REST interface used for checking payment status by Company internal invoice ID:

  • invoiceID - invoice number (LMI_PAYMENT_NO)
  • siteAlias - Merchant ID (LMI_MERCHANT_ID)
  • Parameters used for hashing: login;password;nonce;invoiceID;siteAlias
  • Response parameters are the same as for the previous request

Request example: 

https://psp.wmtransfer.com/partners/rest/getpaymentbyinvoiceid?login=TestLogin&nonce=ttt&invoiceid=1&siteAlias=yyy&hash=123

Response example:

{"ErrorCode":0,"Payment":{"PaymentID":12345,"SiteInvoiceID":"1",
"SiteID":1,"CurrencyCode":"USD","Amount":33,"PaymentSystemID":
0,"PaymentCurrencyCode":null,"PaymentAmount":0,"State":"COMPLETE",
"Purpose":null,"IsTestPayment":false,"UserPhoneNumber":"79161234567",
"UserIdentifier":null,"LastUpdate":"\/Date(1369231716474)\/","LastUpdateTime":
"2013-05-22T18:08:36"}}

Request example: 

https://psp.wmtransfer.com/partners/rest/getpaymentbyinvoiceid?login=TestLogin&nonce=ttt&invoiceid=1&siteAlias=yyy&hash=123&xml=1

Response example:

<RestController.RestResponse xmlns="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Controllers"xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ErrorCode>
        0
    </ErrorCode>
    <Response xmlns:a="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Models.REST" i:type="a:RestPaymentInfo">
        <a:Amount>
            33
        </a:Amount>
        <a:CurrencyCode>
            USD
        </a:CurrencyCode>
        <a:IsTestPayment>
            false
        </a:IsTestPayment>
        <a:LastUpdate>
            2013-05-22T18:03:05.7459579+04:00
        </a:LastUpdate>
        <a:PaymentAmount>
            0
        </a:PaymentAmount>
        <a:PaymentCurrencyCode i:nil="true"/>
        <a:PaymentID>
            12345
        </a:PaymentID>
        <a:PaymentSystemID>
            0
        </a:PaymentSystemID>
        <a:Purpose i:nil="true"/>
        <a:SiteID>
            1
        </a:SiteID>
        <a:SiteInvoiceID>
            1
        </a:SiteInvoiceID>
        <a:State>
            COMPLETE
        </a:State>
        <a:UserIdentifier i:nil="true"/>
        <a:UserPhoneNumber>
            79161234567
        </a:UserPhoneNumber>
    </Response>
</RestController.RestResponse>

Receiving payments list (transaction file)

Returns payments list that match criteria specified in the request .

  • accountID - ID of the Company account. It can be found in URL of the page "Account" in Control Panel. Parameter accountID can not be specified, if there is only one account.
  • siteAlias - Site alias (LMI_MERCHANT_ID). If provided only this site’s payments will be listed.
  • periodFrom - period begin (yyyy-MM-dd), UTC time. If indicated, only payments from this date will be included.
  • periodTo - period end (yyyy-MM-dd), UTC time. If indicated, only payments until this date will be included.
  • invoiceID - invoice number. If indicated, only payments with this number will be included.
  • state - payment state. If indicated, only payments in this state will be included. Possible values:
  • INITIATED
  • PROCESSING
  • COMPLETE
  • CANCELLED
  • Parameters used for hashing: login;password;nonce;accountID;siteAlias;periodFrom;periodTo;invoiceID;state. If a parameter is missing, an empty line is written instead (in other words, there will be two consecutive semi-colons).
  • Response parameters:
  • Response.Overflow - "true", if it is impossible to return all payment data requested. Narrow the search area in that case.
  • Response.Payments - Array of objects, each of it is similar to object described in getPayment interface.

Request example:

https://psp.wmtransfer.com/partners/rest/listpaymentsfilter?login=TestLogin&nonce=ttt&periodFrom=2011-12-01&hash=123

Response example:

{"ErrorCode":0,"Response":{"Overflow":false,"Payments":[{"PaymentID":
123456,"SiteInvoiceID":"2313","SiteID":1,"CurrencyCode":"USD",
"Amount":33,"PaymentMethod":null,"PaymentSystemID":0,"PaymentCurrencyCode":
null,"PaymentAmount":0,"State":"COMPLETE","ErrorCode":0,"Purpose":
null,"IsTestPayment":false,"UserPhoneNumber":"79161234567","UserIdentifier":
null,"Settled":true,"LastUpdate":"\/Date(1399446988043)\/","LastUpdateTime":
"2014-05-07T11:16:28"},{"PaymentID":123458,"SiteInvoiceID":"2315",
"SiteID":1,"CurrencyCode":"USD","Amount":33,"PaymentMethod":
null,"PaymentSystemID":0,"PaymentCurrencyCode":null,"PaymentAmount":0,
"State":"COMPLETE","ErrorCode":0,"Purpose":null,"IsTestPayment":
false,"UserPhoneNumber":"79161234567","UserIdentifier":null,"Settled":
true,"LastUpdate":"\/Date(1399446988043)\/","LastUpdateTime":"2014-05-07T11:
16:28"},{"PaymentID":123476,"SiteInvoiceID":"2316","SiteID":
1,"CurrencyCode":"USD","Amount":33,"PaymentMethod":null,"PaymentSystemID":
0,"PaymentCurrencyCode":null,"PaymentAmount":0,"State":"COMPLETE",
"ErrorCode":0,"Purpose":null,"IsTestPayment":false,"UserPhoneNumber":
"79161234567","UserIdentifier":null,"Settled":true,"LastUpdate":
"\/Date(1399446988043)\/","LastUpdateTime":"2014-05-07T11:16:28"}]}}

Request example:

https://psp.wmtransfer.com/partners/rest/listpaymentsfilter?login=TestLogin&nonce=ttt&periodFrom=2011-12-01&hash=123&xml=1

Response example:

<RestController.RestResponse xmlns="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Controllers" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ErrorCode>
        0
    </ErrorCode>
    <Response xmlns:a="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Models.REST" i:type="a:RestPaymentList">
        <a:Overflow>
            false
        </a:Overflow>
        <a:Payments>
            <a:RestPaymentInfo>
                <a:Amount>
                    33
                </a:Amount>
                <a:CurrencyCode>
                    USD
                </a:CurrencyCode>
                <a:ErrorCode>
                    0
                </a:ErrorCode>
                <a:IsTestPayment>
                    false
                </a:IsTestPayment>
                <a:LastUpdate>
                    2014-05-07T11:15:06.5785898+04:00
                </a:LastUpdate>
                <a:PaymentAmount>
                    0
                </a:PaymentAmount>
                <a:PaymentCurrencyCode i:nil="true"/>
                <a:PaymentID>
                    123456
                </a:PaymentID>
                <a:PaymentMethod i:nil="true"/>
                <a:PaymentSystemID>
                    0
                </a:PaymentSystemID>
                <a:Purpose i:nil="true"/>
                <a:Settled>
                    true
                </a:Settled>
                <a:SiteID>
                    1
                </a:SiteID>
                <a:SiteInvoiceID>
                    2313
                </a:SiteInvoiceID>
                <a:State>
                    COMPLETE
                </a:State>
                <a:UserIdentifier i:nil="true"/>
                <a:UserPhoneNumber>
                    79161234567
                </a:UserPhoneNumber>
            </a:RestPaymentInfo>
            <a:RestPaymentInfo>
                <a:Amount>
                    33
                </a:Amount>
                <a:CurrencyCode>
                    USD
                </a:CurrencyCode>
                <a:ErrorCode>
                    0
                </a:ErrorCode>
                <a:IsTestPayment>
                    false
                </a:IsTestPayment>
                <a:LastUpdate>
                    2014-05-07T11:15:06.5785898+04:00
                </a:LastUpdate>
                <a:PaymentAmount>
                    0
                </a:PaymentAmount>
                <a:PaymentCurrencyCode i:nil="true"/>
                <a:PaymentID>
                    123458
                </a:PaymentID>
                <a:PaymentMethod i:nil="true"/>
                <a:PaymentSystemID>
                    0
                </a:PaymentSystemID>
                <a:Purpose i:nil="true"/>
                <a:Settled>
                    true
                </a:Settled>
                <a:SiteID>
                    1
                </a:SiteID>
                <a:SiteInvoiceID>
                    2315
                </a:SiteInvoiceID>
                <a:State>
                    COMPLETE
                </a:State>
                <a:UserIdentifier i:nil="true"/>
                <a:UserPhoneNumber>
                    79161234567
                </a:UserPhoneNumber>
            </a:RestPaymentInfo>
            <a:RestPaymentInfo>
                <a:Amount>
                    33
                </a:Amount>
                <a:CurrencyCode>
                    USD
                </a:CurrencyCode>
                <a:ErrorCode>
                    0
                </a:ErrorCode>
                <a:IsTestPayment>
                    false
                </a:IsTestPayment>
                <a:LastUpdate>
                    2014-05-07T11:15:06.5785898+04:00
                </a:LastUpdate>
                <a:PaymentAmount>
                    0
                </a:PaymentAmount>
                <a:PaymentCurrencyCode i:nil="true"/>
                <a:PaymentID>
                    123476
                </a:PaymentID>
                <a:PaymentMethod i:nil="true"/>
                <a:PaymentSystemID>
                    0
                </a:PaymentSystemID>
                <a:Purpose i:nil="true"/>
                <a:Settled>
                    true
                </a:Settled>
                <a:SiteID>
                    1
                </a:SiteID>
                <a:SiteInvoiceID>
                    2316
                </a:SiteInvoiceID>
                <a:State>
                    COMPLETE
                </a:State>
                <a:UserIdentifier i:nil="true"/>
                <a:UserPhoneNumber>
                    79161234567
                </a:UserPhoneNumber>
            </a:RestPaymentInfo>
        </a:Payments>
    </Response>
</RestController.RestResponse>

Information Transfer Guidelines for Refunds

Introduction

Every payment in the Processing system can be refunded entirely or partially, at the initiative of the Merchant.

Refunds are non-atomic and, possibly, lengthy operation. It is first initialized, then performed, and then marked as either completed or unsuccessful.

Only one refund can be performed on a payment at a time.

Refund from web office

In the merchant account on the Processing website (https://psp.wmtransfer.com/partners/), refunds are possible from either the Payment List section (click the Refund button in the payment details) or the Refunds section, which is specially made for this purpose.

The Refunds section will also have a history of all refunds (both successful and unsuccessful).

Automatic refunds

For refunds, the following REST interface is available:

  • Request parameters:
  • paymentID - Processing payment ID.
  • amount - refund amount, in the currency of payment.
  • externalID - optional parameter for external refund ID.
  • login - login for automatic Processing requests
  • nonce - one-time ticket (arbitrary line). Requests with repeated nonce instances are not accepted. We recommend using the current time, in some form.
  • Parameters used for hashing: login;password;nonce;paymentID;amount;externalID
  • Response parameters:
  • Response.RefundID - unique ID for the refund transaction.
  • Response.PaymentID - Processing payment ID.
  • Response.Status - refund status:
  • PENDING - queued to commit refund
  • EXECUTING - performing refund
  • SUCCESS - refund successfully performed
  • FAILURE - refund is failed
  • Response.Amount - amount refunded
  • Response.ExternalID - external refund ID
  • Response.ErrorCode - request error code (see Error codes)
  • Response.ErrorDesc - textual description of the error, if the error code is missing. The description also can not be present if the denial reason is unknown. 

Request example:

https://psp.wmtransfer.com/partners/rest/refundPayment?login=TestLogin&nonce=ttt&hash=yY5XgFpg8kCJW42gs2m9VnLnrZs%3d&paymentID=131212&amount=23.10

Response example:

{"ErrorCode":0,"Refund":{"RefundID":1073969831,"ExternalID":null,
"PaymentID":131212,"Amount":23.10,"ErrorCode":null,"ErrorDesc":
null,"State":"EXECUTING"}}

Request example:

https://psp.wmtransfer.com/partners/rest/refundPayment?login=TestLogin&nonce=ttt&hash=yY5XgFpg8kCJW42gs2m9VnLnrZs%3d&paymentID=131212&amount=23.10&xml=1

Response example:

<RestController.RestResponse xmlns="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Controllers" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ErrorCode>
        0
    </ErrorCode>
    <Response xmlns:a="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Models.REST" i:type="a:RestRefundInfo">
        <a:Amount>
            23.10
        </a:Amount>
        <a:ErrorCode i:nil="true"/>
        <a:ErrorDesc i:nil="true"/>
        <a:ExternalID i:nil="true"/>
        <a:PaymentID>
            131212
        </a:PaymentID>
        <a:RefundID>
            697092129
        </a:RefundID>
        <a:State>
            EXECUTING
        </a:State>
    </Response>
</RestController.RestResponse>

Receiving refunds list

The following REST interface returns the list of refunds, by payment or by period:

  • Request parameters:
  • accountID - ID of the Company account.
  • paymentID - payment ID number. If present, only refunds for this payment are displayed.
  • periodFrom - start of period (yyyy-mm-dd). If absent, no lower limit.
  • periodTo - end of period, inclusive (yyyy-mm-dd). If absent, no upper limit.
  • externalID - optional parameter for external refund ID.
  • Parameters used for hashing: login;password;nonce;accountID;paymentID;periodFrom;periodTo;externalID. If a parameter is missing, an empty line is written instead (in other words, there will be two consecutive semi-colons).         
  • Response parameters:
  • Response.ErrorCode - request error code (see Error codes)
  • Response.Overflow - true if the list of refunds is cut off. In this case, specify a narrower range for search.
  • Response.Refunds - refund list. Every object the same as the first Response request object.

Request example:

https://psp.wmtransfer.com/partners/rest/listRefunds?login=TestLogin&nonce=ttt&hash=yY5XgFpg8kCJW42gs2m9VnLnrZs%3d&paymentID=131212&periodFrom=2011-01-01&periodTo=2011-11-11

Response example:

{"ErrorCode":0,"Response":{"Overflow":false,"Refunds":[{"RefundID":
1234,"ExternalID":null,"PaymentID":12345,"Amount":10.2,"ErrorCode":
null,"ErrorDesc":null,"State":"SUCCESS"},{"RefundID":1236,"ExternalID":
null,"PaymentID":12346,"Amount":120,"ErrorCode":-15,"ErrorDesc":
"we\u0027ve been waiting for too long time","State":"FAILURE"}]}}

Request example:

https://psp.wmtransfer.com/partners/rest/listRefunds?login=TestLogin&nonce=ttt&hash=yY5XgFpg8kCJW42gs2m9VnLnrZs%3d&paymentID=131212&periodFrom=2011-01-01&periodTo=2011-11-11&xml=1

Response example:

<RestController.RestResponse xmlns="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Controllers" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ErrorCode>
        0
    </ErrorCode>
    <Response xmlns:a="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Models.REST" i:type="a:RestRefundList">
        <a:Overflow>
            false
        </a:Overflow>
        <a:Refunds>
            <a:RestRefundInfo>
                <a:Amount>
                    10.2
                </a:Amount>
                <a:ErrorCode i:nil="true"/>
                <a:ErrorDesc i:nil="true"/>
                <a:ExternalID i:nil="true"/>
                <a:PaymentID>
                    12345
                </a:PaymentID>
                <a:RefundID>
                    1234
                </a:RefundID>
                <a:State>
                    SUCCESS
                </a:State>
            </a:RestRefundInfo>
            <a:RestRefundInfo>
                <a:Amount>
                    120
                </a:Amount>
                <a:ErrorCode>
                    -15
                </a:ErrorCode>
                <a:ErrorDesc>
                    we've been waiting for too long time
                </a:ErrorDesc>
                <a:ExternalID i:nil="true"/>
                <a:PaymentID>
                    12346
                </a:PaymentID>
                <a:RefundID>
                    1236
                </a:RefundID>
                <a:State>
                    FAILURE
                </a:State>
            </a:RestRefundInfo>
        </a:Refunds>
    </Response>
</RestController.RestResponse>

Receiving documents list

The following REST interface returns the list of documents by period:  

  • periodFrom -period begin (yyyy-MM-dd), UTC time. If indicated, only documents from this date will be included.
  • periodTo - period end (yyyy-MM-dd), UTC time. If indicated, only documents until this date will be included.
  • Parameters used for hashing:

login;password;nonce;accountID;periodFrom;periodTo

  • Response parameters:
  • Created - document creation date
  • Description - document description
  • DocumentID - document ID to download content
  • FileName - document file name

Request example:

https://paymaster.ru/partners/rest/listDocuments?login=TestLogin&nonce=ttt&hash=123&accountID=123&periodFrom=2005-02-17&periodTo=2013-06-17&xml=1

Response example:

<RestController.RestResponse xmlns="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Controllers"xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <ErrorCode>
        0
    </ErrorCode>
    <Response xmlns:a="http://schemas.datacontract.org/2004/07/PaymasterBackoffice.Models.REST"i:type="a:RestDocumentList">
        <a:Documents>
            <a:RestDocumentInfo>
                <a:Created>
                    2013-06-17T12:57:03.6470638Z
                </a:Created>
                <a:Description>
                    Акт выполненных работ за Март 2012 г
                </a:Description>
                <a:DocumentID>
                    123456
                </a:DocumentID>
                <a:FileName>
                    act_052012.xls
                </a:FileName>
            </a:RestDocumentInfo>
            <a:RestDocumentInfo>
                <a:Created>
                    2013-06-17T12:57:03.6470638Z
                </a:Created>
                <a:Description>
                    Invoice #1123 for 05/2012
                </a:Description>
                <a:DocumentID>
                    123456
                </a:DocumentID>
                <a:FileName>
                    doc_052012.xls
                </a:FileName>
            </a:RestDocumentInfo>
        </a:Documents>
    </Response>
</RestController.RestResponse>

Downloading document

The following REST interface used for downloading document by Document ID:

login;password;nonce;documentID

  • Response:
  • requested file

Request example: 

https://paymaster.ru/partners/rest/getDocumentContent?login=TestLogin&nonce=ttt&hash=123&documentID=123456&xml=1