Payler API
Search…
Transfers
When sending requests, use the header "Content-Type: application / x-www-form-urlencoded Characters case and parameters order in requests are not important.
Characters case in url addresses of the requests is important.
The response to the request is transmitted in JSON format, encoding UTF-8.
API responses may contain undocumented fields. While processing responses, such fields should be ignored by the client code.

StartCreditSession

Request for transfer initialization. Runs before redirecting the user to the Payler payment gateway page.
Available for: cgapi
Request method: POST
Request parameters
Name
Format
R/O
Description
key
A..100
R
Merchant ID. Issued to the merchant with the access parameters
password
A..100
R
Merchant's password for operations. Issued to the merchant with the access parameters
order_id
A..100
R
ID of the operation in the merchant system. For each transfer (session), it is required to use a unique identifier. Only printed ASCII-signs are allowed
session_type
N1
O
Session type regarding to the storage of card data. When saving card data, subsequent transfers can be made simply by selecting a proper card. If this parameter equals to 1, then customer_id must also be transmitted. 0—Normal transfer page, without storing card data.
1—Show the list of saved cards to the user and the ability to select a card from the list or enter complete card data for transfer to a card not from the list. By default—0
customer_id
A..100
O
Customer ID. If the session_type parameter is 1, then you will be able to select a previously saved card (for this customer) or enter a new one on the transfer page. Generated by merchant
amount
N
R
Operation amount in minimum currency units (kopecks, cents etc)
product
A..256
O
Transfer description
template
A..100
O
Template used for the transfer page specified by the merchant. If not, the default template is used
lang
A2
O
Preferred language of the payment form responses. en—English; ru—Russian.
By default—Russian
userdata
A..10000
O
User data. In this line, you can pass any information that you need to save with the operation and then get it using GetAdvancedStatus
email
A..100
O
User email
pay_page_param_*
A..100
O
Parameters to display on the transfer page. You can pass any parameters that begin with pay_page_param_, and then display them on the payment page. To do this, you are to use the page template (see parameter template)
Response parameters
Name
Format
R/O
Description
order_id
A..100
R
ID of the operation in the merchant system. Corresponds to the one sent in the request
amount
N
R
Operation amount in minimum currency units (kopecks, cents etc). Corresponds to the one sent in the request
session_id
A..100
R
Identifier of the payment session
Example of the response to a successful request:
{
"amount": 30000,
"session_id": "b088175c-eca6-4317-aa84-74de5080ca20",
"order_id": "d1434908-7260-483e-8254-fa43af1b835d"
}

CreditGate

Redirecting the user from the merchant’s website to the payment form page on the gateway side. Runs after StartCreditSession command. After the user fills in form fields, the gateway automatically performs request to the issuer bank.
Result of processing the request is transfer of funds to user's card.
Available for: cgapi
Request method: GET
Request parameters
Name
Format
R/O
Description
session_id
A..100
R
Session identifier received via a call StartCreditSession​
After processing CreditGate request on the side of the payment gateway, the user will be redirected to the page with the results of the operation and returned to the site of the merchant in 3 seconds.
The return address of the user (URL of the page) is indicated by the merchant in advance as a URL. Example return address: http://myshop.ru/complete?order_id={order_id}​
To obtain operation results, you should use the data obtained within the operation status request (see GetStatus method).
Please note that the return to the specified URL can be made several times, for example, when the user is confused, they click the Back button in the browser and enter thier card data several times for operation. If the user mistakenly tries to save the card again within one session, they see a message stating that the card has already been saved. The user is redirected to the merchant's website.

CreditMerchant

Request a transfer of funds to the user's card.
Available for: cmapi
Request method: POST
Request parameters
Name
Format
R/O
Description
key
A..100
R
Merchant ID. Issued to the merchant with the access parameters
password
A..100
R
Merchant’s password for operations through the Credit Merchant API. Issued to the merchant with the access parameters
order_id
A..100
R
Merchant’s operation ID. Each transfer requires its own unique identifier. Only printed ASCII-signs are allowed
amount
N
R
Operation amount in minimum currency units (kopecks, cents etc)
currency
A3
Đž
Operation currency (see Currencies directory). If not specified, then RUB
card_number
A..19
R
Card number. Decimal digits without delimiters [0–9]
card_holder
A..100
Đž
Name of the cardholder. Latin signs, a decimal digit, or a space character [a-zA-Z0–9]
lang
A2
Đž
Preferred language for server responses. en—English; ru—Russian. By default—Russian
email
A..100
R
User email
userdata
A..1000
O
User data. In this line, you can pass in this line any information that you need to save with the transfer and then get it using GetAdvancedStatus
user_entered_*
A..100
O
You can specify additional fields for the transfer, starting with user_entered_. The maximum length of each parameter is 100 signs. All these fields are then returned to GetAdvancedStatus in the user_entered_params field
pay_page_param_addtoreport3
A
O
When using split payments: transfer amounts for each recipient need to be indicated in the smallest currency unit (kopecks, cents, etc.) separated by commas
pay_page_param_addtoreport4
A
O
When using split payments: recipient IDs need to be separated by commas. IDs are registered by Payler technical support
Response parameters
Name
Format
R/O
Description
order_id
A..100
R
Identifier of the paid order in the merchant system. Corresponds to the one sent in the request
amount
N
R
Operation amount in minimum currency units (kopecks, cents etc). Corresponds to the one sent in the request
card_holder
A..100
R
Name of the cardholder. Corresponds to the one sent in the request
card_number
A..19
O
Masked card number with which the operation is performed
status
A..10
R
Status of the operation
Example of the response to a successful request:
{
"amount": 100,
"card_number": "555555xxxxxx5599",
"card_holder": "test",
"order_id": "19",
"status": "Pending"
}
After completing the CreditMerchant request, you must call GetStatus to get the current status of the operation.

RepeatCredit

Request a transfer of funds to a pre-saved card. The result of processing the request is the transfer of funds.
Available for: cgapi
Request method: POST
Request parameters
Name
Format
R/O
Description
key
A..100
R
Merchant ID
password
A..100
R
Merchant’s password for operations via the Credit Merchant API. Issued to the merchant with the access parameters
order_id
A..100
R
Operation identifier in the merchant system. Each transfer requires its own unique identifier. Only printed ASCII-signs are allowed
customer_id
A..100
O
Customer ID. Generated by the merchant
amount
N
R
Operation amount in minimum currency units (kopecks, cents etc)
currency
A3
O
Operation currency (see Currencies directory).
If not specified, then RUB
card_id
A..100
R
ID of the card to be transferred to
lang
A2
O
Preferred language for server responses. en—English; ru—Russian. By default—Russian
userdata
A..1000
O
User data. In this line, you can pass in this line any information that you need to save with the payment and then get it using GetAdvancedStatus
Currency parameter
If the merchant uses more than one currency, the parameter currency is required!
For example, if a recurring payment template is created for a payment made in USD, then you must specify USD when re-debiting. Otherwise, the payment will be made through the ruble terminal, with currency conversion and the calculation of an additional fee.
Response parameters
Name
Format
R/O
Description
order_id
A..100
R
Identifier of the paid order in the merchant system. Corresponds to the one sent in the request
amount
N
R
Operation amount in minimum currency units (kopecks, cents etc). Corresponds to the one sent in the request
card_holder
A..100
O
Name of the cardholder. Corresponds to the one sent in the request
card_number
A..19
R
Masked card number, with which transfer is effected
status
A..10
R
Status of the operation
Example of the response to a successful request:
{
"amount": 100,
"card_number": "555555xxxxxx5599",
"card_holder": "test",
"order_id": "19",
"status": "Pending"
}
If the operation status is Pending, then the status request should be repeated until the status changes. The request frequency is changed in a geometric progression.
After completing the RepeatCredit request, you must call GetStatus to get the current status of the operation.

GetBalance

Request a balance list.
Available for: cgapi, cmapi
Request method: POST
Request parameters
Name
Format
R/O
Description
key
A..100
R
Merchant ID. Issued to the merchant with the access parameters
Response parameters
Name
Format
R/O
Description
balance
Ar
R
Balance in minimum currency units
name
A
R
Name of the account
currency
A3
R
Currency code
remain
N
R
Account balance
Example of the response to a successful request:
{
"balance": [
{
"name": "Card (Euro)",
"currency": "EUR",
"remain": 0
},
{
"name": "Card (United States Dollar)",
"currency": "USD",
"remain": 0
},
{
"name": "Card (Russian Ruble)",
"currency": "RUB",
"remain": 30000
},
{
"name": "Qiwi (Russian Ruble)",
"currency": "RUB",
"remain": 7000
}
]
}
​
Copy link
On this page
StartCreditSession
CreditGate
CreditMerchant
RepeatCredit
GetBalance