3.5. /api/v2/bank-wire-transfer
Introduction
Bank wire transfer is initiated through HTTPS POST request by using URLs and the parameters specified below. Use SHA-1 for authentication. See Statuses.
API URLs
Integration |
Production |
---|---|
https://sandbox.payneteasy.eu/paynet/api/v2/bank-wire-transfer/ENDPOINTID |
https://gate.payneteasy.eu/paynet/api/v2/bank-wire-transfer/ENDPOINTID |
Request Parameters
Note
Parameter Name |
Description |
Value |
---|---|---|
client_orderid |
Unique order identifier assigned by Connecting Party. |
Necessity : RequiredType : StringLength : 128 |
currency |
Currency the transaction is charged in (See: Currency codes). Sample values are: USD for US Dollar EUR for European Euro. |
Necessity : RequiredType : StringLength : 3 |
payer-fullname |
Payer’s full name. |
Necessity : RequiredType : StringLength : 128 |
recipient-account-number |
Receiver`s account number. |
Necessity : RequiredType : NumericLength : 20 |
recipient-bank-bic |
Receiver`s Bank Identifier Code. |
Necessity : RequiredType : NumericLength : 9 |
amount |
Amount to be charged. The amount has to be specified in the highest units with . delimiter. For instance, 10.5 for USD means 10 US Dollars and 50 Cents. |
Necessity : RequiredType : NumericLength : 10 |
payer-email |
Payer’s e-mail address. |
Necessity : OptionalType : StringLength : 128 |
payer-phone |
Payer’s full international phone number, including country code. |
Necessity : OptionalType : StringLength : 128 |
recipient-name |
Receiver`s name. |
Necessity : RequiredType : StringLength : 255 |
recipient-inn |
Receiver`s Taxpayer Identification Number. |
Necessity : RequiredType : StringLength : 255 |
payment-details |
Payment purpose. |
Necessity : RequiredType : StringLength : 120 |
vat-amount |
Value-added tax amount. |
Necessity : RequiredType : NumericLength : 10 |
payer-identity-document |
Type, series and number of the identification card. |
Necessity : RequiredType : StringLength : 64 |
control |
Checksum generated by SHA-1. Control string is represented as concatenation of the following parameters:
1. <ENDPOINTID> (See: Request URL)
2. Request parameter: client_orderid
4. Request parameter: payer-fullname
8. Request parameter: recipient-name
5. Request parameter: recipient-account-number
6. Request parameter: recipient-bank-bic
7. Request parameter: amount (in minor units)
9. Request parameter: vat-amount (in minor units)
3. Request parameter: currency
10. merchant_control (Control key assigned to Connecting Party in Payment Gateway.)
|
Necessity : RequiredType : StringLength : 40 |
server_callback_url |
URL, where the transaction status is sent to.
Connecting Party may use server callback URL for custom processing of the transaction completion, e.g. to collect payment data in the Connecting Party’s information system.
For the list of parameters which come along with server callback to server_callback_url refer to Connecting Party callback parameters.
|
Necessity : OptionalType : StringLength : 128 |
Response Parameters
Note
Parameter name |
Description |
---|---|
type |
The type of response. May be async-form-response, validation-error, error. If type equals validation-error or error, error-message and error-code parameters contain error details. |
paynet-order-id |
Order id assigned to the order by Payneteasy. |
merchant-order-id |
Connecting Party order id. |
serial-number |
Unique number assigned by Payneteasy server to particular request from the Connecting Party. |
error-message |
If status is declined or error this parameter contains the reason for decline or error details. |
error-code |
The error code in case of declined or error status. |
Request Example
POST /paynet/api/v2/bank-wire-transfer/40265 HTTP/1.1
User-Agent: curl/7.83.0
Accept: */*
Content-Length: 436
Content-Type: application/x-www-form-urlencoded
Connection: close
client_orderid=902B4FF5
&payer-fullname=Test full name
&recipient-name=Test name
&recipient-account-number=40963810202157880527
&recipient-bank-bic=44030861
&amount=55.55
&vat-amount=4.54
¤cy=EUR
&payer-email=john.smith@gmail.com
&payer-phone=+74951129876
&recipient-inn=7812013775
&payment-details=Test payment
&payer-identity-document=01,9207123123
&server_callback_url=https://httpstat.us/200
&control=bc7dae1fe9389aa02471c7c93d08d6b1ba0f2ea8
Success Response Example
HTTP/1.1 200
Server: server
Date: Fri, 26 May 2023 11:44:12 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 145
type=async-response
&serial-number=00000000-0000-0000-0000-000003c3994f
&merchant-order-id=inv9157586
&paynet-order-id=1824084
&end-point-id=6655
Fail Response Example
HTTP/1.1 200
Server: server
Date: Fri, 26 May 2023 10:11:58 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 163
type=validation-error
&serial-number=00000000-0000-0000-0000-000002e73881
&merchant-order-id=902B4FF5
&error-message=Project+with+currency+USD+does+not+apply+request+with+currency+EUR
&error-code=20
Postman Collection
Request Builder
String to sign |
---|
Signature |
---|
|