add Partner request is used for registration of new shop partner in wayforpay system.
The request processing result is the partner adding to the shop and transfer of his/her details.
Request parameters
The request with the required parameters is generated on the side of the merchant and transferred with the help of POST method through HTTP protocol to URL https://api.wayforpay.com/mms/addPartner.php
In order to confirm the data validity, there shall be generated and transferred in the HMAC_MD5 request the control signature with use of the merchant SecretKey.
The line, subject to HMAC_MD5, is generated through concatenation of UTF-8-encoded merchantAccount, partnerCode, phone, email separated with “;” (semicolon)
| Parameter | Description | Mandatory |
|---|---|---|
| merchantAccount | Merchant identifier. This value is assigned by WayForPay | yes |
| merchantSignature | Request signature | yes |
| partnerCode | Partner code – partner name – partner id | yes |
| site | Merchant web-site | yes |
| phone | Merchant telephone number in international format | yes |
| | Merchant E-mail | yes |
| description | Description of merchant shop/shop activity category | no |
| compensationCardNumber | Compensation card number | no |
| compensationCardExpYear | Expiry year (string 4) | no |
| compensationCardExpMonth | Expiry month (string 2) | no |
| compensationCardCvv | Card CVV code | no |
| compensationCardHolder | Card owner name and surname | no |
| compensationAccount | Compensation bank account number (string 4-20) | no |
| compensationAccountIban | IBAN accounts | no |
| compensationAccountMfo | Bank MFO (string 6) | no |
| compensationAccountOkpo | Recipient OKPO/ITN (string 8,10 or 14) | no |
| compensationAccountName | Legal entity/account name | no |
| compensationCardToken | Compensation card token | no |
Response parameters
| Parameter | Description | Example |
|---|---|---|
| partnerCode | Partner code | partner_merch_n1 |
| reason | Request result | Ok |
| reasonCode | Request processing result code. | 1100 |
Request and response example
{
"merchantAccount":"test_merch_n1",
"merchantSignature":"4a76353de3a7ce3c9d9c8a362d37f28b",
"partnerCode":"superPartner1",
"phone":"380901234567",
"email":"ff1f@com",
"compensationCardNumber":"4111111111111111",
"compensationCardHolder":"super holder",
"compensationCardExpYear":"2029",
"compensationCardExpMonth":"05",
"compensationCardCvv":"111",
"description":"description of shop"
}{
"reason":"Ok",
"reasonCode":"1100",
"partnerCode":"site.com"
}
