This API gives the possibility to credit settlement account of legal entities and self-employed persons from the bank account of the retail and service outlet.
You may credit settlement account, opened with any Ukrainian Bank.
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/api
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, orderReference, amount, currency, iban, okpo, accountName separated with “;” (semicolon)
| Parameter | Description | Mandatory |
|---|---|---|
| transactionType | Request type, possesses the value of P2P_ACCOUNT | yes |
| merchantAccount | Merchant unique identifier. | yes |
| merchantAuthType | Authorization type: simpleSignature (by default) | no |
| orderReference | Unique order number in the merchant system | yes |
| amount | Transfer amount | yes |
| currency | Transfer currency: UAH | yes |
| iban | International bank account number | yes |
| okpo | Code OKPO | yes |
| accountName | Recepient name | yes |
| merchantSignature | Order signature | yes |
| apiVersion | Protocol version. Default value: 1 | yes |
| description | Payment purpose description. Money will be sent to the account with this description | no |
| serviceUrl | URL, where the system shall send the answer with the result of crediting directly to the merchant | no |
| recipientLastName | Recipient surname | no |
| recipientPhone | Recipient telephone number | no |
| recipientEmail | Recipient E-mail | no |
Answer parameters
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, orderReference, amount, currency, authCode, cardPan, transactionStatus, reasonCode separated with “;” (semicolon)
| Parameter | Description | Example |
|---|---|---|
| merchantAccount | Merchant identifier | test_merchant_n1 |
| orderReference | Unique order number in the merchant system | 1212dd1 |
| merchantSignature | Order signature | hash_hmac |
| amount | Order amount | 100 |
| currency | Order currency | UAH |
| processingDate | Date of transaction processing (UTC) | 12345678 |
| transactionStatus | Transaction status | Approved |
| reason | Reason for rejection | Ok |
| reasonCode | Rejection code | 1100 |
Request and answer example
{
"transactionType":"P2P_ACCOUNT",
"merchantAccount":"p2p_account",
"merchantAuthType":"simpleSignature",
"merchantSignature":"60c5d743b71f79abe48c7183ada4b451",
"apiVersion":1,
"orderReference":"myOrder1",
"amount":10.13,
"currency":"UAH",
"iban":"UA261234560000026000000000000",
"okpo":"123456789",
"accountName":"ФОП Iванов Iван Iванович",
"description":"Спалата рахунку №2"
}
{
"merchantAccount": "p2p_account",
"orderReference": "myOrder1",
"merchantSignature":"b95932786cbe243a76b014846b63fe92",
"amount": 10.13,
"currency": "UAH",
"createdDate": 1415379863,
"processingDate": 1415379863,
"transactionStatus": "Approved",
"reason": "Ok",
"reasonCode": 1100
}
