Request for the list of bindings of a certain bank card (getBindingsByCardOrId)

Provided that a store has corresponding permissions, it can get the list of all bindings that relate to a certain bank card. This can be done by a card number or by a known binding identifier. The method used for getting the list of bindings of a bank card is getBindingsByCardOrId. The response returns all the bindings available to the merchant in accordance with their settings.

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
`pan`	N12…19	Required if `bindingId` is not indicated.	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. In the case of payment via Apple Pay, DPAN is used as the card number: a number associated with the buyer's mobile device and acting as a payment card number in the Apple Pay system.
`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.
`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.
`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	Yes	Error description in the language passed in the `language` parameter in the request.
`bindings` element (contains blocks that consist of the bindingId, maskedPan, expiryDate and clientId parameters):
`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. 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.

Error codes

Error code	Error text
0	The request has been processed without system errors.
1	Search parameters `[pan]` or `[bindingId]` are not set.
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/>
   <soapenv:Body>
      <mer:getBindingsByCardOrId>
         <request pan="4111111111111111" bindingId=" " showExpired="true" language="ru"/>
      </mer:getBindingsByCardOrId>
   </soapenv:Body>
</soapenv:Envelope>

Response example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:getBindingsByCardOrIdResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant">
         <return errorCode="0" errorMessage="Success">
            <bindings>
               <binding bindingId="9f43e86d-9744-42a5-8646-c4bb7cf8799a" maskedPan="411111**1111" expiryDate="201912" clientId="12345"/>
               <binding bindingId="51c0750b-1a23-424b-8989-5e8f669124b4" maskedPan="411111**1111" expiryDate="201512" clientId="123456"/>
               <binding bindingId="6a8c0738-cc88-4200-acf6-afc264d66cb0" maskedPan="411111**1111" expiryDate="201912" clientId="666"/>
               <binding bindingId="97a70989-c1fb-49f7-8a42-27c19dc160dw" maskedPan="411111**1111" expiryDate="201512" clientId="666"/>
            </bindings>
         </return>
      </ns1:getBindingsByCardOrIdResponse>
   </soap:Body>
</soap:Envelope>