Request for getting a card synonym

The mass payouts protocol is now outdated. If you want to make payouts via the API, use the YooMoney API.

In order to make a transfer to a bank card, you need to get the synonym of the bank card number. You can do it the YooMoney’s side or independently, by request.

To get the synonym independently, you will need to place a form for entering card data on their website. After confirming input, the form data is sent using the POST method. YooMoney processes the received data and uses the GET method to redirect the payer to the URL specified in skr_successUrl or skr_errorUrl. If successful, the synonym, mask, and additional parameters of the payer’s card are appended to the address.

Request parameters

Address for sending requests

https://paymentcard.yoomoney.ru/gates/card/storeCard

Parameter	Type	Description
skr_destinationCardNumber	xs:string, up to 25 characters	Bank card number.
skr_responseFormat	xs:string, to 8 characters	Format of the response to the request. Possible values: `redirect` or `json`. If the parameter is omitted, `redirect` is used by default.
skr_errorUrl	xs:string, up to 250 characters	URL for redirecting in case of an error
skr_successUrl	xs:string, up to 250 characters	URL for redirecting in case of an success

Code sample for a page for storing the card number on the YooMoney side and getting its synonym

HTML
<html>
    <body>
        <form action=https://paymentcard.yoomoney.ru/gates/card/storeCard method=post>
        <input type=text name=skr_destinationCardNumber/> <br/>
        <input type=hidden name=skr_responseFormat value=redirect/> <br/>
        <input type=text name="skr_errorUrl" value="http://example.com/error"/> <br/>
        <input type=text name="skr_successUrl" value="http://example.com/success"/> <br/>
        <input type=submit value="Save"/>
    </body>
</html>

Parameters of the response to the request

Parameter	Type	Description
Required parameters
skr_destinationCardPanmask	xs:string, up to 25 characters	Bank card mask
skr_destinationCardSynonim	xs:string, up to 100 characters	Bank card synonym
reason	xs:string, up to 100 characters	Result of data processing: `success` if successful, `cardinvalid` if failed.
Additional parameters
skr_destinationCardBankName	xs:string, up to 200 characters	Name of the card-issuing bank
skr_destinationCardCountryCode	xs:string, up to 3 characters	Numeric code of the card-issuing country
skr_destinationCardPaymentSystem	xs:string, up to 100 characters	Name of the card’s payment system
skr_destinationCardProductName	xs:string, up to 1000 characters	Name of the card product
skr_destinationCardProductCode	xs:string, up to 20 characters	Code of the card product

Example of a redirect format response

[skr_successUrl]/?skr_destinationCardProductCode=P&skr_destinationCardProductName=Visa+Gold&skr_destinationCardSynonim=4878b27eaec2022c5a6a4e82d971a6271bf6fcd8_scn&skr_destinationCardType=Visa&skr_destinationCardCountryCode=616&skr_destinationCardBankName=Norwegian+Visa-Bankgroup&skr_destinationCardPanmask=444444******4448

Example of a JSON format response for successfully saving the card number

JSON
{"storeCard":{"skr_destinationCardSynonim":"e651e9fd23d00efa97fc713682fcc7f86faeb846_scn","skr_destinationCardPanmask":"471408*****1089"}}

Example of a JSON format response for failure to save the card number

JSON
{"storeCard":{"reason":"cardinvalid"}}

Use the synonym of the card number received in the response for YooMoney deposit requests. YooMoney uses the received synonym to determine the recipient’s card number.