3.23. /api/v2/payout-form

Introduction

To make a payout-form request send an HTTPS POST request - by using URLs and the parameters specified below. Use OAuth RSA-SHA256 for authentication.

API URLs

Note

The path in API URL should not be hardcoded, as it may be changed in future.

Integration

Production

https://sandbox.payneteasy.com/paynet/api/v2/payout-form/ENDPOINTID

https://gate.payneteasy.com/paynet/api/v2/payout-form/ENDPOINTID

https://sandbox.payneteasy.com/paynet/api/v2/payout-form/group/ENDPOINTIDGROUPID

https://gate.payneteasy.com/paynet/api/v2/payout-form/group/ENDPOINTGROUPID

Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.
Ask Support Manager if Conditional fields are Required for integration.

Parameter Name

Description

Value

client_orderid

Connecting Party’s order identifier.
Necessity: Required
Type: String
Lenght: 128

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: Required
Type: Numeric
Lenght: 10

currency

Currency the transaction is charged in (three-letter currency code). Sample values are: USD for US Dollar EUR for European Euro.
Necessity: Required
Type: String
Length: 3

order_desc

Brief order description.
Necessity: Conditional
Type: String
Length: 64

ipaddress

Receiver’s IP address (IPv4 or IPv6).
Necessity: Conditional
Type: String
Length: 7-45

purpose

Payout purpose.
Necessity: Conditional
Type: String
Length: 128

server_callback_url

URL the transaction result will be sent to. Merchant may use this URL for custom processing of the transaction completion, e.g. to collect sales data in Merchant’s database. See more details at Connecting Party Callbacks.
Necessity: Optional
Type: String
Length: 1024

redirect_url
URL, where the Receiver is redirected to upon completion of the transaction. Please note that redirection is performed in any case, no matter whether transaction is approved, declined in any other final status.
Connecting Party must not use the parameters come along with the redirect HTTP Request to treat the status of the transaction. Instead Connecting Party can utilize server_callback_url or status API command. Pass https://doc.payneteasy.com if you have no need to return Receiver anywhere. Use either redirect_url or combination of redirect_success_url and redirect_fail_url, not both.
Necessity: Required if both redirect_success_url and redirect_fail_url are missing
Type: String
Length: 1024

redirect_succes_url
URL, where the Receiver is redirected to when transaction status is approved (See status list).
Connecting Party must not use the parameters come along with the redirect HTTP Request to treat the status of the transaction. Instead Connecting Party can utilize server_callback_url or status API command. Otherwise put https://doc.payneteasy.com if there is no need to redirect Receiver anywhere. Use either combination of redirect_success_url and redirect_fail_url or redirect_url, not both.
Necessity: Required if redirect_url parameter is missing
Type: String
Lenght: 1024

redirect_fail_url
URL, where the Receiver is redirected to when transaction status is not approved (See status list).
Connecting Party must not use the parameters come along with the redirect HTTP Request to treat the status of the transaction. Instead Connecting Party can utilize server_callback_url or status API command. Pass https://doc.payneteasy.com if you use non-3DS schema for transactions processing and you have no need to return Receiver anywhere. Use either combination of redirect_fail_url and redirect_success_url or redirect_url, not both.
Necessity: Required if redirect_url parameter is missing
Type: String
Length: 1024

account_number

Account number.
Necessity: Conditional
Type: String
Length: 24

account_name

Bank account.
Necessity: Conditional
Type: String
Length: 128

ewallet_type

Type of e-wallet.
Necessity: Conditional
Type: String
Length: 64

ewallet_wallet

E-wallet ID.
Necessity: Conditional
Type: String
Length: 128

crypto_wallet_address

Address of crypto wallet.
Necessity: Conditional
Type: String
Length: 64

bank_name

Bank Name.
Necessity: Conditional
Type: String
Length: 255

bank_branch

Bank Branch Name.
Necessity: Conditional
Type: String
Length: 255

bank_code

Bank code.
Necessity: Conditional
Type: String
Length: 32

bank_address1

Bank address.
Necessity: Conditional
Type: String
Length: 255

bank_zip_code

Bank postal ZIP code.
Necessity: Conditional
Type: String
Length: 255

bank_province

Bank province.
Necessity: Conditional
Type: String
Length: 255

bank_area

Bank area.
Necessity: Conditional
Type: String
Length: 255

routing_number

Routing number used to identify specific bank branches in China.
Necessity: Conditional
Type: String
Length: 16

legal_person_name

Name on the legal document.
Necessity: Conditional
Type: String
Length: 128

legal_person_document_number

Number of legal document.
Necessity: Conditional
Type: String
Length: 128

receiver_first_name

Receiver first name, also can be sent as first_name.
Necessity: Conditional
Type: String
Length: 128

receiver_last_name

Receiver last name, also can be sent as last_name.
Necessity: Conditional
Type: String
Length: 128

receiver_birthday

Receiver birthday, also can be sent as birthday.
Necessity: Conditional
Type: Numeric
Length: 30

receiver_country_code

Receiver country code, also can be sent as country.
Necessity: Conditional
Type: String
Length: 3

receiver_state

Receiver state, should be provided for countries that have states (USA, Canada, Australia), also can be sent as state.
Necessity: Conditional
Type: String
Length: 4

receiver_city

Receiver city, also can be sent as city.
Necessity: Conditional
Type: String
Length: 128

receiver_zip_code

Receiver zip code, also can be sent as zip_code.
Necessity: Conditional
Type: Numeric
Length: 32

receiver_address1

Receiver address, also can be sent as address1.
Necessity: Conditional
Type: String
Length: 256

receiver_phone

Receiver phone, also can be sent as phone.
Necessity: Conditional
Type: Numeric
Length: 128

receiver_email

Receiver E-mail, also can be sent as email.
Necessity: Conditional
Type: String
Length: 128

receiver_identity_document_id

Receiver identity document identifier, also can be sent as identity_document_id.
Necessity: Conditional
Type: String
Length: 128

receiver_identity_document_number

Receiver identity document number, also can be sent as identity_document_number.
Necessity: Conditional
Type: String
Length: 128

merchant_data

Any additional information for this transaction which may be useful in Connecting Party’s external systems, e.g. VIP customer, TV promo campaign lead. Will be returned in Status response and Connecting Party’s Callback.
Necessity: Optional
Type: String
Length: 64k

merchant_form_data

Parameters sent in merchant_form_data API parameter are parsed into macros with the same name, the parameter is url-encoded, example: testparam%3Dtest1%26mynewparam%3Dtest2 and is parsed into $MFD_testparam = test1 and $MFD_mynewparam = test2 macros in the form. Parameter name characters[a-zA-Z0-9], parameter value characters[a-zA-Z0-9], control characters [=&], 2MB max size. For example, this parameter can be used to display payment form in light/dark mode depending on the value passed by Connecting Party (e.g. pass merchant_form_data=theme%3Ddark in request and $MFD_theme macro placeholder on payment form will be changed to dark.
Necessity: Optional
Type: String
Length: 128

preferred_language

Preferred language
Necessity: Optional
Type: String
Length: 2

bank_bic

BIC of the recipient’s bank.
Necessity: Conditional
Type: String
Length: 128

receiver_inn

Recipient’s INN.
Necessity: Conditional
Type: String
Length: 128

card_recurring_payment_id

Payer’s tokenized cardholder’s data ID. Send either card_recurring_payment_id or combination of credit_card_number, card_printed_name, expire_month and expire_year, not all. To create card_recurring_payment_id see /api/v2/create-card-ref.
Necessity: Optional
Type: Long

Response Parameters

Note

Response has Content-Type: text/html;charset=utf-8 header. All fields are x-www-form-urlencoded, with (0xA) character at the end of each parameter’s value.

Parameter Name

Description

type

The type of response. May be async-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 error this parameter contains the reason for decline or error details.

error-code

The error code is case of error status.

redirect_url

The URL to the page where the Connecting Party should redirect the client’s browser. Connecting Party should send HTTP 302 redirect.

Request Example

POST /paynet/api/v2/payout/ENDPOINTID HTTP/1.1
Host: sandbox.doc2.com
User-Agent: curl/8.12.1
Accept: */*
Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="merchantlogin",oauth_timestamp="1753337681",oauth_nonce="T5v7kcMBsgi",oauth_signature_method="HMAC-SHA1",oauth_signature="wTTQQiN%2F2bGjfCTcSAQ3ZhAHMLw%3D"
Content-Length: 249
Content-Type: application/x-www-form-urlencoded
Connection: keep-alive

account_number=1234567890
&amount=100&bank_branch=test_branch
&bank_name=test_bank
&client_orderid=12345
&currency=USD
&oauth_consumer_key=merchantlogin
&oauth_nonce=T5v7kcMBsgi
&oauth_signature_method=HMAC-SHA1
&oauth_timestamp=1753337681
&oauth_version=1.

Success Response Example

HTTP/1.1 200
Server: server
Date: Thu, 24 Jul 2025 06:45:56 GMT
Content-Type: text/html;charset=utf-8
Connection: keep-alive
Keep-Alive: timeout=60
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: 142

type=async-response
&serial-number=00000000-0000-0000-0000-000002f3b45d
&merchant-order-id=12345
&paynet-order-id=7366391
&end-point-id=132490

Fail Response Example

HTTP/1.1 403
Server: server
Date: Thu, 24 Jul 2025 06:26:23 GMT
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Connection: keep-alive
Keep-Alive: timeout=60
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Length: 102

type=error
&serial-number=00000000-0000-0000-0000-000002f3b456
&error-message=Forbidden
&error-code=-1

Test Scenario

Different Payout transaction statuses can be received on sandbox depending on the account_number value passed in Payout request.

Testing account_number values:

  • account_number = 1234567890 to get APPROVED

  • account_number = 0987654321 to get DECLINED

  • account_number = 1987654321 to get PROCESSOR_INTERNAL_ERROR

Postman Collection

Request Builder

HTTP method
URL

Use /v2/payout-form/ in URL for Payout Form integration

parameters
version
consumer key
consumer secret
timestamp
nonce
signature method

normalized parameters
signature base string
signature
authorization header