API URL: https://payeer.com/ajax/api/api.php
- Authorization Check
- Balance Check
- Transferring Funds
- Checking Existence of Account
- Automatic Conversion Rates
- Checking Possibility of Payout
- Payout
- Getting Available Payment Systems
- Payment details
- History of transactions
- Payout details
- Creating an invoice for payment
- Merchant API
Payeer provides external developers with options for interacting with the service via software. One such interaction method is the use of an API.
The API determines a set of functions for facilitating interaction on HTTPs protocols. Using these functions, it is possible to gain access to various system resources such as information about payout methods in the Payeer system, exchange rates, or information on specific payments in the system, as well as to generate a withdrawal.
This interaction is performed using POST queries in UTF-8 encoding to the URL: https://payeer.com/ajax/api/api.php.
Each response from the Payeer server must contain the auth_error field, which shows whether or not the authentication parameters have been entered correctly.
The response to the query will also contain the array errors, which refers to the presence of errors when fulfilling the query. An "errors" field that is blank or contains the values "false", "null", or "0" indicates that there were no errors whatsoever when fulfilling the query; otherwise a text description of the error that occurred is returned.
In order to work with the API, you must in the profile at https://payeer.com/en/account/?tab=api click on the button "Activation" in the right column.
Enter the name of the user, generate a secret key for working with the API, and, in order to provide additional security, enter the IP address from which you will be sending queries to the Payeer server.
Warning! Never share your secret API key with anyone.
Once you have added the API you will receive a user ID that you will have to use along with a key and an account number for authentication in queries.
-
When I send a query to the API I get this error message: "Auth error: account or apiId or apiPass is incorrect or api-user was blocked."
Check to make sure your account number, API user ID, and secret key have been entered correctly and that the user has not been blocked in the "Mass Payouts" settings -
I can’t get rid of the the error message "IP 1.2.3.4 does not satisfy the security settings."
Enter the IP that was returned in the error message in the "Mass Payouts" settings and repeat the query. -
After a while the error message "Auth error: account or apiId or apiPass is incorrect or api-user was blocked” appears again, although no settings have been changed.
After a certain number of login attempts with an invalid secret key an API user will be blocked. The user can be unblocked in the "Mass Payouts" settings. It is possible that you have changed the secret key everywhere on your website or that someone is attempting to acquire the password to your API.
1) Delete the old API user
2) Create a new one with IP protection
3) Register the new access information on your website -
Someone hacked my website and withdrew all the money through the API
For additional security you can use a second account for payouts where you keep the amount necessary for short-term transfers. Please do not neglect the performance of safety checks for your website.
The simplest query is checking authorization. It does not have to be fulfilled separately from primary actions.
To check authorization, send a POST query to the URL https://payeer.com/ajax/api/api.php with three parameters:
account, apiId и apiPass:
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | the API user’s ID; given out when adding the API | 12345 |
| apiPass | the API user's secret key | qwerty |
Two parameters will be returned in the body of the response: auth_error и errors:
| auth_error | errors | |
|---|---|---|
| 0 | Authorization successful | |
| 1 | Auth error: account or apiId or apiPass is incorrect or api-user was blocked | Authorization error Account number, apiID, or apiPass entered incorrectly or the API user has been blocked in the settings |
| 1 | IP 1.2.3.4 does not satisfy the security settings | Authorization error Queries come from the IP 1.2.3.4, although another one has been registered in the API user's settings |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[]}
-
Getting a wallet balance.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: balance check | getBalance |
| type | return type | object (default), array |
| Parameter | Description |
|---|---|
| currency | currency code |
| total | total balance |
| available | available balance for payouts |
| hold | amount of frozen funds |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=getBalance
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"balance":{"USD":{"currency":"USD","total":92.49,"available":92.49,"hold":0},"RUB":{"currency":"RUB","total":218.07,"available":207.77,"hold":10.3},"EUR":{"currency":"EUR","total":4.04,"available":4.04,"hold":0},"BTC":{"currency":"BTC","total":0.00639515,"available":0.00639515,"hold":0},"ETH":{"currency":"ETH","total":0.04548519,"available":0.04548519,"hold":0},"BCH":{"currency":"BCH","total":0.02113917,"available":0.02113917,"hold":0},"LTC":{"currency":"LTC","total":0.0898946,"available":0.0898946,"hold":0},"DASH":{"currency":"DASH","total":0.03482208,"available":0.03482208,"hold":0},"USDT":{"currency":"USDT","total":1.0e-8,"available":1.0e-8,"hold":0},"XRP":{"currency":"XRP","total":52.216613,"available":52.216613,"hold":0}}}
-
Transfer funds within the Payeer system.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: transfer | transfer |
| curIn | currency with which the withdrawal will be performed | USD, EUR, RUB |
| sum | amount withdrawn (the amount deposited will be calculated automatically, factoring in all fees from the recipient) | 1.00 |
| curOut | deposit currency (if the withdrawal currency is different from the deposit currency, the conversion will be performed automatically based on the Payeer system’s exchange rate when the transfer takes place) | USD, EUR, RUB |
| sumOut | amount deposited (the amount withdrawn will be calculated automatically, factoring in all fees from the sender) | 1.00 |
| to | user’s Payeer account number or email address (if the email address was not registered before the transfer, the registration will be performed automatically) | P1000000, test@mail.com |
| comment | comments on the transfer (this should preferably show the transaction ID in your accounting system) | Transfer #1365 |
| protect | activation of transaction protection (to have the transfer deposited into the recipient’s account you will have to enter the protectCode protection code within protectCode days; otherwise the transfer will be canceled and the funds will remain in the sender's account) | Y |
| protectPeriod | protection period: 1–30 days | 1–30 |
| protectCode | protection code | 12345 |
| referenceId | identification number in your accounting system | 08d7f228-5a03-4dc7-b13a-7c14146df8f7 |
required parameters are in bold
| Parameter | Description |
|---|---|
| errors | array of errors or false |
| success | true, false |
| historyId | transaction number |
List of potential errors:
| Error | Description |
|---|---|
| balanceError | insufficient funds for transfer |
| balanceError000 | insufficient funds for transfer given limitations on the account |
| transferHimselfForbidden | you cannot transfer funds to yourself (when the withdrawal currency and deposit currency are the same) |
| transferError | transfer error, try again later |
| convertForbidden | automatic exchange of curIn for curOut is temporarily prohibited |
| protectDay_1_30 | error entering transfer protection period |
| protectCodeNotEmpty | the protection code cannot be blank when protection is active |
| sumNotNull | the amounts sent and received cannot be zero |
| sumInNotMinus | the amount sent cannot be negative |
| sumOutNotMinus | the amount received cannot be negative |
| fromError | sender not found |
| toError | recipient entered incorrectly |
| curInError | withdrawal currency not supported |
| curOutError | reception currency not supported |
| outputHold | Issues have arisen regarding your activity. Please contact Technical Support |
| transferToForbiddenCountry | Transfer to customers in certain countries is prohibited |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=transfer&curIn=USD&sum=1&curOut=USD&to=P1000001
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":false,"success":true,"historyId":925947210}
-
You can check the existence of an account number prior to transfer in the Payeer system..
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: check existence of account | checkUser |
| user | user’s account number in the format P1000000 | P1000000 |
If success=true, this means that the user exists.
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=checkUser&user=P1000441
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"success":true}
-
If during deposit/transfer/withdrawal the withdrawal currency curIn is different from the receiving currency curOut, the amount will be converted based on Payeer’s internal echange rates, which can be obtained using the following method.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: obtain automatic conversion rates | getExchangeRate |
| output | select currencies for conversion rates | N - get deposit rates Y - get withdrawal rates |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=getExchangeRate&output=Y
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"rate":{"RUB\/USD":"0.01477541","RUB\/RUB":1,"RUB\/EUR":"0.01308525","USD\/USD":1,"USD\/RUB":"61.47230000","USD\/EUR":"0.85757203","EUR\/USD":"1.09716731","EUR\/RUB":"69.53140000"}}
-
This method allows you to check the possibility of a payout without actually creating a payout (you can get the withdrawal/reception amount or check errors in parameters)
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: checking possibility of payout | payoutChecking |
| ps | ID of selected payment system | 1136053 |
| sumIn | amount withdrawn (the amount deposited will be calculated automatically, factoring in all fees from the recipient) | 1.00 |
| curIn | currency with which the withdrawal will be performed | USD, EUR, RUB |
| sumOut | amount deposited (the amount withdrawn will be calculated automatically, factoring in all fees from the sender) | 1.00 |
| curOut | deposit currency (if the withdrawal currency is different from the deposit currency, the conversion will be performed automatically based on the Payeer system’s exchange rate when the transfer takes place) | USD, EUR, RUB |
| param_ACCOUNT_NUMBER | recipient's account number in the selected payment system ps |
P1000441 |
| referenceId | identification number in your accounting system | 08d7f228-5a03-4dc7-b13a-7c14146df8f7 |
List of potential errors:
| Error | Description |
|---|---|
| curIn invalid | withdrawal currency not supported |
| curOut invalid | deposit currency not supported |
| This type of exchange is not possible | automatic exchange of curIn for curOut is temporarily prohibited |
| invalid format | invalid parameter format |
| pay_sys_no_isset | payout method is disabled or does not exist |
| cur_no_pay_sys | non-existent deposit currency |
| sum_less_min | amount received is below the minimum |
| sum_more_max | amount received is above the maximum |
| output_block | Issues have arisen regarding your activity. Please contact Technical Support |
| balans_no | insufficient funds for withdrawal |
| balans_no_hold | insufficient funds for withdrawal given limitations on the account |
| balance_sys_no | no reserve for the creation of a payout |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=payoutChecking&ps=1136053&sumIn=1&curIn=USD&curOut=RUB¶m_ACCOUNT_NUMBER=P1000001
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":null,"outputParams":{"sumIn":1,"curIn":"USD","curOut":"RUB","ps":1136053,"sumOut":"61.47"}}
-
A payout to any payment system that supports Payeer. You can find a list of payment systems on the corresponding tab in the API user settings or using the special getPaySystems method.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: payout | payout |
| ps | ID of selected payment system | 1136053 |
| sumIn | amount withdrawn (the amount deposited will be calculated automatically, factoring in all fees from the recipient) | 1.00 |
| curIn | currency with which the withdrawal will be performed | USD, EUR, RUB |
| sumOut | amount deposited (the amount withdrawn will be calculated automatically, factoring in all fees from the sender) | 1.00 |
| curOut | deposit currency (if the withdrawal currency is different from the deposit currency, the conversion will be performed automatically based on the Payeer system’s exchange rate when the transfer takes place) | USD, EUR, RUB |
| param_ACCOUNT_NUMBER | recipient's account number in the selected payment system ps |
P1000441 |
| referenceId | identification number in your accounting system | 08d7f228-5a03-4dc7-b13a-7c14146df8f7 |
List of potential errors:
| Error | Description |
|---|---|
| curIn invalid | withdrawal currency not supported |
| curOut invalid | deposit currency not supported |
| This type of exchange is not possible | automatic exchange of curIn for curOut is temporarily prohibited |
| invalid format | invalid parameter format |
| pay_sys_no_isset | payout method is disabled or does not exist |
| cur_no_pay_sys | non-existent deposit currency |
| sum_less_min | amount received is below the minimum |
| sum_more_max | amount received is above the maximum |
| output_block | Issues have arisen regarding your activity. Please contact Technical Support |
| balans_no | insufficient funds for withdrawal |
| balans_no_hold | insufficient funds for withdrawal given limitations on the account |
| balance_sys_no | no reserve for the creation of a payout |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=payout&ps=1136053&sumIn=1&curIn=USD&curOut=RUB¶m_ACCOUNT_NUMBER=P1000001
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":false,"outputParams":{"sumIn":1,"curIn":"RUB","curOut":"RUB","ps":1136053,"sumOut":0},"historyId":1975716}
-
This method returns a list of payment systems that are available for payout.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: get available payment systems | getPaySystems |
The list array contains a list of payment systems for payout:
| Parameter | Description |
|---|---|
| id | payment system ID (which is required to use for payout) |
| name | payment system name |
| gate_commission | gateway fee for each supported currency |
| gate_commission_min | minimum gateway fee for each currency |
| gate_commission_max | maximum gateway fee for each currency |
| currencies | supported currencies |
| commission_site_percent | Payeer’s fee in percent |
| r_fields | list of parameters for creating a payout |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=getPaySystems
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"list":{"1136053":{"id":"1136053","name":"Payeer","gate_commission":[],"gate_commission_min":[],"gate_commission_max":[],"currencies":["USD","RUB","EUR"],"commission_site_percent":0,"r_fields":{"ACCOUNT_NUMBER":{"name":"\u041d\u043e\u043c\u0435\u0440 \u0441\u0447\u0435\u0442\u0430","reg_expr":"#^P[0-9]+$#","example":"P1000000"}}}}}
-
Payment details.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: payment details | paymentDetails |
| merchantId | merchant id (m_shop) | 12345 |
| referenceId | invoice id in the seller's accounting system (m_orderid) | 117d3e31-f950-4766-a63d-5b7785aa51b6 |
| Parameter | Description | Example |
|---|---|---|
| errors | array of errors | |
| success | true, false | |
| items | array of payments (last 10 payments) | |
| amount | invoice amount (m_amount) | 1 |
| currency | invoice currency (m_curr) | USD |
| description | description (m_desc) | Test payment |
| referenceId | invoice id in the seller's accounting system (m_orderid) | 117d3e31-f950-4766-a63d-5b7785aa51b6 |
| created | creation date | 2020-01-20 14:05:30 |
| processed | payment date | 2020-01-20 14:05:48 |
| paySystemName | name of the payment method | Payeer |
| paySystemId | id of the payment method | 2609 |
| clientAmount | amount to be paid by the client | 1 |
| clientCurrency | currency | USD |
| clientAccount | Payeer number of the payer's wallet | P1000001 |
| clientEmail | payer's email address | client@payeer.com |
| profitAmount | amount credited to the merchant's account | 0.99 |
| profitCurrency | currency | USD |
| profitTransactionId | profit transaction id | 928562504 |
| merchantTransactionId | payment transaction id | 928562360 |
| created_ts | creation date in unixtime format | 1579518330 |
| processed_ts | payment date in unixtime format | 1579518348 |
| merchantFee | amount of the merchant fee | 0.01 |
| merchantCurrency | currency of the merchant fee | USD |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=paymentDetails&merchantId=12345&referenceId=117d3e31-f950-4766-a63d-5b7785aa51b6
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"success":true,"items":[{"amount":1,"currency":"USD","description":"Test payment","referenceId":"117d3e31-f950-4766-a63d-5b7785aa51b6","created":"2020-01-20 14:05:30","processed":"2020-01-20 14:05:48","paySystemName":"Payeer","paySystemId":"2609","clientAmount":1,"clientCurrency":"USD","clientAccount":"P1000001","clientEmail":"client@payeer.com","profitAmount":0.99,"profitCurrency":"USD","profitTransactionId":"928562504","merchantTransactionId":"928562360","created_ts":1579518330,"processed_ts":1579518348,"merchantFee":0.01,"merchantCurrency":"USD"}]}
-
Get the history of account transactions.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: get the history of account transactions | history |
| sort | sorting by date (default desc) | asc, desc |
| count | count of records (max 1000) | 10 |
| from | begin of the period | 2016-03-02 15:35:17 |
| to | end of the period | 2016-03-31 13:47:06 |
| type | transaction type | incoming - incoming payments outgoing - outgoing payments |
| append | id of the previous transaction | 197941396 |
| id | getting history by transaction id | 197941396 |
| Parameter | Description | Example |
|---|---|---|
| id | transaction ID | 197941397 |
| date | Date/time of creation in the format YYYY-MM-DD HH:MM:SS | 2016-03-02 15:35:17 |
| type | transaction type | transfer - transfer deposit - deposit withdrawal - withdrawal sci - payment to the store |
| status | transaction status | success - complete (final status) processing - in progress (changes to success, canceled, or pending) canceled - canceled (final status) waiting - expected (for example, when waiting for a payment) (changes to success, canceled, or pending) pending - pending (changes to success, canceled) |
| from | sender's account number | P1000000, @anonum, @merchant, null |
| debitedAmount | amount withdrawn | 1 |
| debitedCurrency | withdrawal currency | USD, EUR, RUB |
| to | recipient's account number | P1000001, @sms, null |
| creditedAmount | amount received | 1 |
| creditedCurrency | deposit currency | USD, EUR, RUB |
| payeerFee | Payeer’s fee | 0.01 |
| gateFee | gateway fee | 0.01 |
| comment | comments | test |
| paySystem | name payment method | Payeer |
| shopId | merchant id | 12345 |
| shopOrderId | id invoice of merchant | 123 |
| exchangeRate | exchange rate for auto-conversion | 1 |
| protect | transaction protection for transfer | Y, N |
| protectDay | number of days for protection | 1-30, null |
| isApi | via API | Y, N |
| shop | sci parameters | id - store id domain - domain store orderid - invoice id of store description - description |
| apiId | API user ID the transaction was made through | 12345 |
| referenceId | identification number in your accounting system | 08d7f228-5a03-4dc7-b13a-7c14146df8f7 |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=history
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"params":{},"history":{}}
-
Getting payout information using Reference ID.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: getting payout information | payoutDetails |
| referenceId | identification number in your accounting system | 08d7f228-5a03-4dc7-b13a-7c14146df8f7 |
| referenceApiId | id of the api-user (apiId is used by default) | 123456 |
| Parameter | Description | Example |
|---|---|---|
| id | transaction ID | 197941397 |
| date | Date/time of creation in the format YYYY-MM-DD HH:MM:SS | 2016-03-02 15:35:17 |
| type | transaction type | transfer - transfer withdrawal - withdrawal |
| status | transaction status | success - complete (final status) processing - in progress (changes to success, canceled, or pending) canceled - canceled (final status) |
| from | sender's account number | P1000000 |
| debitedAmount | amount withdrawn | 1 |
| debitedCurrency | withdrawal currency | USD, EUR, RUB |
| to | recipient's account number | P1000001 |
| creditedAmount | amount received | 1 |
| creditedCurrency | deposit currency | USD, EUR, RUB |
| payeerFee | Payeer’s fee | 0.01 |
| gateFee | gateway fee | 0.01 |
| comment | comments | test |
| paySystem | name payment method | Payeer |
| exchangeRate | exchange rate for auto-conversion | 1 |
| protect | transaction protection for transfer | Y, N |
| protectDay | number of days for protection | 1-30, null |
| isApi | via API | Y, N |
| apiId | API user ID the transaction was made through | 12345 |
| referenceId | identification number in your accounting system | 08d7f228-5a03-4dc7-b13a-7c14146df8f7 |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=payoutDetails&referenceId=08d7f228-5a03-4dc7-b13a-7c14146df8f7
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"params":{},"history":{}}
-
Creating an invoice for payment.
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: creating an invoice | invoiceCreate |
| m_shop | merchant id | 12345 |
| m_orderid | invoice id in the seller's accounting system | test |
| m_amount | invoice amount | 10 |
| m_curr | currency amount | USD |
| m_desc | description | Test Invoice |
| Parameter | Description |
|---|---|
| errors | array of errors |
| success | true, false |
| url | the link for payment |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwerty&action=invoiceCreate&m_shop=12345&m_orderid=test&m_amount=10&m_curr=USD&m_desc=Test%20Invoice
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"success":true,"url":"https:\/\/payeer.com\/merchant\/?m_shop=12345&m_orderid=test&m_amount=10.00&m_curr=USD&m_desc=VGVzdCBJbnZvaWNl&m_sign=123FB8F0B661B63F30B673443582D855447E62E90631988811AC9F4F147BCE97"}
-
You can use this method for automatic invoicing in a necessary payment system.
The method is enabled only for stores with high turnover by prior request
| Parameter | Description | Example |
|---|---|---|
| account | Your account number in the Payeer system | P1000000 |
| apiId | The API user’s ID; given out when adding the API | 12345 |
| apiPass | The API user's secret key | qwerty |
| action | action type: invoice via API | merchant |
| processUrl | URL for redirection to invoice payment | https://payeer.com/api/merchant/process.php |
| merchantUrl | URL of the payment expectation page | https://payeer.com/merchant/ |
| lang | interface language | ru, en |
| shop | JSON data |
m_shop - merchant ID m_orderid - invoice ID in your accounting system m_amount - amount due m_curr - invoice currency m_desc - comments to invoice, encoded in base64 m_params - array of data of additional parameters m_sign - signature |
| ps | JSON data |
id - payment system ID, which can be viewed in the merchant settings in the "Appearance" tab curr - payment system currency |
| form | JSON data | order_email - email address of the customer who will pay the invoice |
| ip | customer IP | 8.8.8.8 |
Array of data of additional parameters (m_params):
| Name | Key | Description |
|---|---|---|
| Success URL | success_url | This is the address the customer will be redirected to once payment has been completed successfully |
| Fail URL | fail_url | This is the address the customer will be redirected to in the event of an error in the payment process or if payment is cancelled |
| Status URL | status_url | The address of the payment processor. This page is where orders can be marked as paid or, for example, funds can be sent to the customer’s account on your website |
| Additional fields | reference | An array of additional fields that must be returned to the payment processor |
| Domain of sub-merchant | submerchant | Domain of sub-merchant (only for aggregators) |
| Parameter | Description |
|---|---|
| location | URL for redirecting the user for payment or expectation of payment |
| orderid | invoice number in the Payeer accounting system |
| historyid | transaction number in the Payeer accounting system |
| historytm | timestamp of the creation of the transaction in Payeer |
List of potential errors:
| Error | Description |
|---|---|
| Shop API is disabled | merchant API disabled for the selected merchant (by default for all merchants) |
| The payment system is forbidden | the selected payment system is currently unavailable |
| PS currency is not supported | the selected currency is not supported for the selected PSС |
| Currency is not supported | this currency is not supported by Payeer |
| Amount is too large | amount due is too high |
| Summa less min | payment amount is below the minimum |
| sum_more_max | the amount exceeds the maximum for the selected PS |
| Invalid sign | signature m_sign is invalid |
| field_required | this field is mandatory |
| field_invalid_regexp | this field does not correspond to a regular expression |
-
Request
-
Headers
Content-Type: application/x-www-form-urlencoded -
Body
account=P1000000&apiId=12345&apiPass=qwertyaction=merchant&lang=ru&shop={"m_shop":"1234567","m_orderid":"12345","m_amount":"1.00","m_curr":"USD","m_desc":"VGVzdA==","m_sign":"2F1C3BF2B64229E59AAA4CDE746DC8E99E6E001AA721C07269832B9EDF9DBDD8"}&ps={"id":"2609","curr":"USD"}&form={"order_email":"test@payeer.com"}
-
-
Response 200 (application/json)
-
Body
{"auth_error":"0","errors":[],"location":"https:\/\/payeer.com\/api\/merchant\/process.php?m_historyid=1980775&m_historytm=1000919709&m_curorderid=254431&lang=ru&referer=https%3A%2F%2Fpayeer.com%2Fmerchant%2F%3Fm_historyid%3D1980775%26m_historytm%3D1000919709%26m_curorderid%3D254431%26lang%3Dru","orderid":254431,"historyid":1980775,"historytm":1000919709}
-