Request for the list of bindings of a Customer (getBindings)

The request used for getting the list of bindings by Customer identifier is getBindings.

Use the following URL to connect to the Test Service (WSDL):
https://3dsec.sberbank.ru/payment/webservices/merchant-ws?wsdl.

In this document, the following data type conventions are used when describing request and response parameters:

A<n> – a sequence of Latin letters of length <n>;
A..<n> – a sequence of Latin letters with a length not exceeding <n>;
N<n> – a sequence of digits of length <n>;
N..<n> – a sequence of digits with a length not exceeding <n>;
AN<n> – a sequence of Latin letters and numbers of fixed length <n>;
AN.. <n> – a sequence of Latin letters and numbers with a length not exceeding <n>;
ANS<n> – a sequence of Latin letters, numbers and characters of fixed length <n>
ANS.. <n> – a sequence of Latin letters, numbers and characters with a length not exceeding <n>;
UTC – date and time, in this case: the date must be passed without specifying the time zone, Moscow time, for the SOAP protocol, the standard encoding xs: dateTime is used.

Request parameters

Name	Type	Mandatory	Description
`userName`	AN..30	Yes	Login of the service account of the merchant.
`password`	AN..30	Yes	Merchant's service account password.
`clientId`	ANS..255	Yes	Identifier of the Customer in the Store system. This parameter is used for the binding functionality. May be present if the store is allowed to create bindings. Specifying this parameter when processing payments with the use of bindings is mandatory. Otherwise, a payment will be unsuccessful.
`bindingId`	AN..255	No	Identifier of the binding created earlier.
`showExpired`	boolean	No	This parameter defines the necessity to display bindings with expired card validity periods. The available values are: true, false. By default the parameter has the false value.
`bindingCategoryType`	ENUM (A1 per element)	Yes	List of possible values: C – standard binding for payments with no specific payment schedule or plan; I – binding for installment payments; R – binding for recurring payments; CR – binding used to store the recipient's PAN in P2P transactions.
`language`	A2	No	Language in the ISO 639-1 encoding. If the language is not specified, the default language defined in the store settings is used.

Response parameters

Name	Type	Mandatory	Description
`errorCode`	ANS..3	Yes	Error code.
`errorMessage`	AN..512	(on an error)	Error description in the language passed in the `language` parameter in the request.
`bindings` element
`bindingId`	AN..255	No	The identifier of the previously created binding. Can only be used if the merchant has permission to work with bindings. If this parameter is passed in the given request, it means that: 1. The given order can be paid only using a binding; 2. The payer will be redirected to the payment page on which only entering CVC is required.
`maskedPan`	N..19	No	Masked number of the card that has been used for the payment. This parameter is to be specified only after the order has been paid.
`expiryDate`	N6	No	Expiry date of the card in the format YYYYMM. This parameter is to be specified only after the order has been paid.
`clientId`	ANS..255	No	Identifier of the Customer in the Store system.
`paymentWay`	AS..14	No	The way of order completion (a payment with entering card data, a payment using a binding, etc.). Possible values: `CARD` – payment with entering of card details; `CARD_BINDING` - payment by binding; `CARD_MOTO` - payment through call center; `CARD_PRESENT` - payment by cardPresent; `SBRF_SBOL` – payment through Sberbank Online; `UPOP` - payment through China Union Pay; `FILE_BINDING` - payment by file; `SMS_BINDING` - payment by SMS; `P2P` - transfer from card to card; `P2P_BINDING` - transfer by binding; `PAYPAL` – payment from a PayPal account; `MTS` – payment from MTS account; `APPLE_PAY` - Apple Pay; `APPLE_PAY_BINDING` - payment by Apple Pay binding; `ANDROID_PAY` - Android Pay; `ANDROID_PAY_BINDING` - payment by Android Pay binding; `GOOGLE_PAY_CARD` - Google Pay, non-tokenized; `GOOGLE_PAY_CARD_BINDING` - payment by binding with non-tokenized Google Pay card; `GOOGLE_PAY_TOKENIZED` - Google Pay, tokenized; `GOOGLE_PAY_TOKENIZED_BINDING` - payment by binding with tokenized Google Pay card; `SAMSUNG_PAY` - Samsung Pay; `SAMSUNG_PAY_BINDING` - payment by Samsung Pay binding; `IPOS` - iPOS payment; `SBERPAY` – SberPay payment; `SBERID` – SberID payment.
`paymentSystem`	N..10	No	The payment system name. Available values: `VISA`; `MASTERCARD`; `AMEX`; `JCB`; `CUP`; `MIR`.
`bindingCategory`	ENUM (A1 per element)	No	List of possible values: C – standard binding for payments with no specific payment schedule or plan; I – binding for installment payments; R – binding for recurring payments; CR – binding used to store the recipient's PAN in P2P transactions.

Error codes

Error code	Error text
0	The request has been processed without system errors.
1	`[clientId]` is empty.
2	The information is not found.
5	Access denied.
5	The user must change the password.
7	System error.

Examples

Request example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merchant">
    <soapenv:Header>
                <wsse:Username>username</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
       <mer:getBindings>
          <request clientId="12345678" showExpired="false" language="ru" bindingCategoryType="C">
          </request>
       </mer:getBindings>
    </soapenv:Body>
 </soapenv:Envelope>

Response example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns1:getBindingsResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
            <return errorCode="0" errorMessage="Success">
                <bindings>
                    <binding bindingId="614d6438-40fe-7b65-9d22-b41d00cd1fba" maskedPan="555555XXXXXX5599" expiryDate="202412" paymentWay="CARD"/>
                    <binding bindingId="22397ac5-af0b-7daa-b1e6-48a300cd1fba" maskedPan="427601XXXXXX6064" expiryDate="202412" paymentWay="CARD"/>
                    <binding bindingId="2912702b-4c5b-7822-9cd7-260500cd1fba" maskedPan="427601XXXXXX6122" expiryDate="202212" paymentWay="CARD"/>
                    <binding bindingId="fa0c41fb-fb94-709c-83f9-0aca00cd1fba" maskedPan="427601XXXXXX6065" expiryDate="202412" paymentWay="CARD"/>
                </bindings>
            </return>
        </ns1:getBindingsResponse>
    </soap:Body>
</soap:Envelope>