1.2.12. Payout V4 Transactions

Process Payout transaction

Payout transaction in most cases is used for bank account funding. In order to transfer funds to bank card, use Deposit to Card Transfer.

If in doubt, please contact Payneteasy support manager to clarify the preferred integration.

For integration purposes use staging environment sandbox.payneteasy.com instead of production gate.payneteasy.com.

Payout transactions are initiated through HTTPS POST request by using URL in the following format:

Payout transaction request URL

The End point ID is an entry point for incoming Merchant`s transactions for single currency integration.

https://gate.payneteasy.com/paynet/api/v4/payout/ENDPOINTID for Payout transactions or https://gate.payneteasy.com/paynet/api/v4/payout-by-ref/ENDPOINTID for Payout By Ref transactions.

The End point group ID is an entry point for incoming Merchant`s transactions for multi currency integration.

https://gate.payneteasy.com/paynet/api/v4/payout/group/ENDPOINTGROUPID - for Payout transactions.

The End point ID and End point group ID are an entry point for incoming Merchant’s transactions and are actually the only Payneteasy object which are exposed via API.

Payout Request Parameters

In order to initiate a Payout or Payout By Ref transaction Merchant sends an HTTPS POST request with the parameters specified in Payout Request Parameters Table below.

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Ask your Support Manager if Conditional fields are Mandatory for your integration.

Warning

To activate Payout By Ref operations, contact Payneteasy support.

Payout Request Parameter	Length/Type	Comment	Necessity*
client_orderid	128/String	Merchant order identifier.	Mandatory
amount	10/Numeric	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	Mandatory
currency	3/String	Currency the transaction is charged in (three-letter currency code). Sample values are: USD for US Dollar EUR for European Euro	Mandatory
order_desc	64/String	Brief order description	Optional
ipaddress	7-45/String	Customer’s IP address (IPv4 or IPv6)	Conditional*
purpose	128/String	Payout purpose	Conditional*
server_callback_url	128/String	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 Merchant Callbacks	Optional
redirect_url	128/String	URL the merchant or customer will be redirected to upon completion of the transaction. Please note that the user will be redirected in any case, no matter whether the transaction is approved or declined. You should not use this parameter to retrieve results from Payneteasy gateway, because all parameters go through user’s browser and can be lost during transmission. To deliver the correct payment result to your backend use server_callback_url instead. Used only in specific cases.	Conditional*
redirect_success_url	1024/String	URL the merchant or customer will be redirected to upon completion of the transaction. Please note that the user will be redirected only in case if the transaction is approved. You should not use this parameter to retrieve results from Payneteasy gateway, because all parameters go through client’s browser and can be lost during transmission. To deliver the correct payment result to your backend use server_callback_url instead. Used only in specific cases.	Conditional*
redirect_fail_url	1024/String	URL the merchant or customer will be redirected to upon completion of the transaction. Please note that the user will be redirected only in case if the transaction is declined or filtered. You should not use this parameter to retrieve results from Payneteasy gateway, because all parameters go through client’s browser and can be lost during transmission. To deliver the correct payment result to your backend use server_callback_url instead. Used only in specific cases.	Conditional*
credit_card_number	20/Numeric	Customer’s credit card number.	Conditional*
card_printed_name	128/String	Customer’s full name, as printed on the card	Conditional*
expire_month	2/Numeric	Credit card expiration month	Conditional*
expire_year	4/Numeric	Credit card expiration year	Conditional*
cvv2	3-4/Numeric	Customer’s CVV2 code. CVV2 (Card Verification Value) is a three- or four-digit number AFTER the credit card number in the signature area of the card.	Conditional*
destination-card-ref-id	50/String	Tokenized card number, can be sent instead of cardholder details in Payout By Ref integration. For more details about getting card-ref-id see Card Registration Diagram page	Conditional*
account_number	24/String	Account Number	Conditional*
account_name	128/String	Bank account	Optional
ewallet_type	64/String	Type of e-wallet	Conditional*
ewallet_wallet	128/String	E-wallet ID	Conditional*
crypto_wallet_address	64/String	Address of crypto wallet	Conditional*
bank_name	255/String	Bank Name	Conditional*
bank_branch	255/String	Bank Branch Name	Conditional*
bank_code	32/String	Bank code	Conditional*
bank_city	128/String	Bank city	Conditional*
bank_address1	255/String	Bank address	Conditional*
bank_zip_code	255/String	Bank postal ZIP code	Conditional*
bank_province	255/String	Bank province	Conditional*
bank_area	255/String	Bank area	Conditional*
routing_number	16/String	Routing number used to identify specific bank branches in China	Conditional*
legal_person_name	128/String	Name on the legal document	Conditional*
legal_person_document_number	128/String	Number of legal document	Conditional*
receiver_first_name	128/String	Receiver first name, also can be sent as first_name	Conditional*
receiver_middle_name	128/String	Receiver middle name, also can be sent as middle_name	Conditional*
receiver_last_name	128/String	Receiver last name, also can be sent as last_name	Conditional*
receiver_birthday	30/Numeric	Receiver birthday, also can be sent as birthday	Conditional*
receiver_country_code	3/String	Receiver country code, also can be sent as country	Conditional*
receiver_state	4/String	Receiver state, should be provided for countries that have states (USA, Canada, Australia), also can be sent as state	Conditional*
receiver_city	128/String	Receiver city, also can be sent as city	Conditional*
receiver_zip_code	32/Numeric	Receiver zip code, also can be sent as zip_code	Conditional*
receiver_address1	256/String	Receiver address, also can be sent as address1	Conditional*
receiver_phone	128/Numeric	Receiver phone, also can be sent as phone	Conditional*
receiver_email	128/String	Receiver E-mail, also can be sent as email	Conditional*
receiver_identity_document_id	128/String	Receiver identity document identifier, also can be sent as identity_document_id	Conditional*
receiver_identity_document_number	128/String	Receiver identity document number, also can be sent as identity_document_number	Conditional*
merchant_data	64k/String	Any additional information for this transaction which may be useful in Merchant’s external systems, e.g. VIP customer, TV promo campaign lead. Will be returned in Status response and Merchant Callback.	Optional
card_recurring_payment_id	Long	Sender’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 Process Card Registration via v4/create-card-ref	Optional

For Faster Payments System (СБП) use the following fields to pass parameters:

Payout Request Parameter	Length/Type	Comment	Necessity*
amount	10/Numeric	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	Mandatory
phone	50/String	Receiver phone	Mandatory
bank_code	32/String	Bank code	Mandatory
currency	3/String	Currency the transaction is charged in (three-letter currency code). Sample value: RUB	Mandatory
receiver_first_name	50/String	Receiver first name	Mandatory
receiver_last_name	50/String	Receiver last name	Mandatory
receiver_middle_name	50/String	Receiver middle name	Mandatory
order_desc	64/String	Brief order description	Mandatory

Payout Request Example

account_number=1234567890
&amount=100
&bank_branch=test
&bank_name=test
&client_orderid=12345
&currency=USD
&oauth_consumer_key=payout_test
&oauth_nonce=EqINVv5rkhx
&oauth_signature_method=RSA-SHA256
&oauth_timestamp=1513785920
&oauth_version=1.0
&routing_number=123456

Payout Response

Note

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

Payout Request Parameters	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	Merchant order id
serial-number	Unique number assigned by Payneteasy server to particular request from the Merchant.
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

Payout Response Example

type=async-response
&serial-number=00000000-0000-0000-0000-0000000624e8
&merchant-order-id=59e1e3ca-5d44-11e1-b3d6-002522b853b4
&paynet-order-id=94935

Process Payout Form transaction

For integration purposes use staging environment sandbox.payneteasy.com instead of production gate.payneteasy.com.

Payout-form transactions are initiated through HTTPS POST request by using URL in the following format:

Form transaction by ENDPOINTID

https://gate.payneteasy.com/paynet/api/v4/payout-form/ENDPOINTID - for single currency integration.

Form transaction by ENDPOINTGROUPID

https://gate.payneteasy.com/paynet/api/v4/payout-form/group/ENDPOINTGROUPID - for multi currency integration.

The End point ID and End point group ID are an entry point for incoming Merchant’s transactions and are actually the only Payneteasy object which are exposed via API.

Payout Form Request Parameters

In order to initiate a Payout transaction Merchant sends an HTTPS POST request with the parameters specified in Payout Form Request Parameters Table below.

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Ask your Support Manager if Conditional fields are Mandatory for your integration.

Payout Request Parameter	Length/Type	Comment	Necessity*
client_orderid	128/String	Merchant order identifier.	Mandatory
amount	10/Numeric	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	Mandatory
currency	3/String	Currency the transaction is charged in (three-letter currency code). Sample values are: USD for US Dollar EUR for European Euro	Mandatory
order_desc	64/String	Brief order description	Mandatory
ipaddress	7-45/String	Customer’s IP address (IPv4 or IPv6)	Conditional*
purpose	128/String	Payout purpose	Conditional*
server_callback_url	1024/String	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 Merchant Callbacks	Optional
redirect_url	1024/String	URL the merchant or customer will be redirected to upon completion of the transaction. Please note that the user will be redirected in any case, no matter whether the transaction is approved or declined. You should not use this parameter to retrieve results from Payneteasy gateway, because all parameters go through user’s browser and can be lost during transmission. To deliver the correct payment result to your backend use server_callback_url instead.	Mandatory if both redirect_success_url and redirect_fail_url are missing
redirect_success_url	1024/String	URL the merchant or customer will be redirected to upon completion of the transaction. Please note that the user will be redirected only in case if the transaction is approved. You should not use this parameter to retrieve results from Payneteasy gateway, because all parameters go through client’s browser and can be lost during transmission. To deliver the correct payment result to your backend use server_callback_url instead. Used only in specific cases.	Mandatory if redirect_url parameter is missing
redirect_fail_url	1024/String	URL the merchant or customer will be redirected to upon completion of the transaction. Please note that the user will be redirected only in case if the transaction is declined or filtered. You should not use this parameter to retrieve results from Payneteasy gateway, because all parameters go through client’s browser and can be lost during transmission. To deliver the correct payment result to your backend use server_callback_url instead. Used only in specific cases.	Mandatory if redirect_url parameter is missing
account_number	24/String	Account Number	Conditional*
account_name	128/String	Bank account	Conditional*
ewallet_type	64/String	Type of e-wallet	Conditional*
ewallet_wallet	128/String	E-wallet ID	Conditional*
crypto_wallet_address	64/String	Address of crypto wallet	Conditional*
bank_name	255/String	Bank Name	Conditional*
bank_branch	255/String	Bank Branch Name	Conditional*
bank_code	32/String	Bank code	Conditional*
bank_address1	255/String	Bank address	Conditional*
bank_zip_code	255/String	Bank postal ZIP code	Conditional*
bank_province	255/String	Bank province	Conditional*
bank_area	255/String	Bank area	Conditional*
routing_number	16/String	Routing number used to identify specific bank branches in China	Conditional*
legal_person_name	128/String	Name on the legal document	Conditional*
legal_person_document_number	128/String	Number of legal document	Conditional*
receiver_first_name	128/String	Receiver first name, also can be sent as first_name	Conditional*
receiver_last_name	128/String	Receiver last name, also can be sent as last_name	Conditional*
receiver_birthday	30/Numeric	Receiver birthday, also can be sent as birthday	Conditional*
receiver_country_code	3/String	Receiver country code, also can be sent as country	Conditional*
receiver_state	4/String	Receiver state, should be provided for countries that have states (USA, Canada, Australia), also can be sent as state	Conditional*
receiver_city	128/String	Receiver city, also can be sent as city	Conditional*
receiver_zip_code	32/Numeric	Receiver zip code, also can be sent as zip_code	Conditional*
receiver_address1	256/String	Receiver address, also can be sent as address1	Conditional*
receiver_phone	128/Numeric	Receiver phone, also can be sent as phone	Conditional*
receiver_email	128/String	Receiver E-mail, also can be sent as email	Conditional*
receiver_identity_document_id	128/String	Receiver identity document identifier, also can be sent as identity_document_id	Conditional*
receiver_identity_document_number	128/String	Receiver identity document number, also can be sent as identity_document_number	Conditional*
merchant_data	64k/String	Any additional information for this transaction which may be useful in Merchant’s external systems, e.g. VIP customer, TV promo campaign lead. Will be returned in Status response and Merchant Callback.	Optional
merchant_form_data	128/String	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.	Optional
preferred_language	2/String	Preferred language	Optional
bank_bic	128/String	BIC of the recipient’s bank	Optional
receiver_inn	128/String	Recipient’s INN	Optional
card_recurring_payment_id	Long	Sender’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 Process Card Registration via v4/create-card-ref	Optional

Payout Form Request Example

account_number=1234567890
&amount=100
&bank_branch=test
&bank_name=test
&client_orderid=12345
&currency=USD
&oauth_consumer_key=payout_test
&oauth_nonce=EqINVv5rkhx
&oauth_signature_method=RSA-SHA256
&oauth_timestamp=1513785920
&oauth_version=1.0
&routing_number=123456

Payout Form Response

Note

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

Payout Request Parameters	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	Merchant order id
serial-number	Unique number assigned by Payneteasy server to particular request from the Merchant.
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 Merchant should redirect the client’s browser. Merchant should send HTTP 302 redirect, see General Payment Form Process Flow

Payout Form Response Example

type=async-response
&serial-number=00000000-0000-0000-0000-0000000624e8
&merchant-order-id=59e1e3ca-5d44-11e1-b3d6-002522b853b4
&paynet-order-id=94935
&redirect_url=https://sandbox.payneteasy.com/paynet/form/init/BB411111...222

Payout Postman Collection

Payout, payout-form and payout by ref requests debug

To reproduce your API call, input all of the data from your original request, including the authentication tokens. Don’t forget to set the nonce and timestamp to the values you used. An OAuth signed URL should match regardless of the generating library. If the signatures differ, you know there is a bug in your OAuth signature code. Due to current PCI DSS restrictions only OAuth 1.0a RSA-SHA256 signature is allowed. Other signature methods are restricted. So to send command to the server your request should be: sent as POST, contains OAuth 1.0a headers, signed with RSA-SHA256.

Generating a pair of public and private keys

You need only private and public key to authorize your transaction. To generate it please go to https://www.openssl.org/ (https://slproweb.com/products/Win32OpenSSL.html), download latest version of openssl and run following commands:

openssl genpkey -algorithm RSA -out private_key_pkcs_8.pem -pkeyopt rsa_keygen_bits:4096

openssl rsa -pubout -in private_key_pkcs_8.pem -out public_key.pem

Share your Private key with no one, you should be the only person to know it. Your Public key, on the contrary, should be sent to your manager, so he can register it in the system. Use different keys for production and for testing purposes to avoid its compromisation.

Private key

For using this demo you need private key in PKCS#1 container. The format of the key should be PKCS#1 PEM text formatted and unencrypted RSA private key. To get it use the following command

openssl rsa -in private_key_pkcs_8.pem -out private_key_pkcs_1.pem

Warning

The private key must be kept secret from everyone.

As a result you will get a key starting with —–BEGIN RSA PRIVATE KEY—–. For production purposes you can use key in any format supported by your software. This demo supports key length up to 4096. Insert your RSA Private key for sandbox environment below.

-----BEGIN RSA PRIVATE KEY----- MIIJKQIBAAKCAgEA16QK2iwgYUbMr2GqSbaS0PQZKF2DkstSj0dakW+hASTz5Ams R5sDnurfeR4m+Htaxiv69MMdvoDLuCmZE8KQzsEOZovZ9UYSh9CKK4/FzQSZ8ZDP 8cpKLN7/gitWiM14iuC9Pi74TTLeg7PuGjeoc0jUs0WMf7sV6uzfZwvqYgUVRljY gscwDRiTSGJQumQtanCs/LMIkxouThLztSSEmHhhEz2aWOomqR5hHO+HJ4I1AfET V7VpKJ4c1+zMesDfpDxZ8VpQpno9iikFG64MigDFmBeskI6q15tBwbROYSfqNEmG LwhYQ+SXnojueazkSJ45CeQRh6dn3GgD7kex2N3lK97qpqDcWOLqcsbe+ZyTGALn WGzTZWjleO+yrdE6awD34kUYVnzD/9WvdYqpH2pXBDqOIXu6lm4gLe5pKTRiFEc+ TjgVb34tJGEERkrvqktSEmRQzMgZQnZk/5//7+csUIcSPmqdUn5oB6ngVueZkk7v wtL6dcCxr5isWgXQEO+oYbt72Ns5RjLVWiXWv2ZNFd+iR4O6+etBxYNz+mg/2B5c PO8NWyvvFlaBUu4I5GG1XntBGWncKQiZ49WCvLcYEbSfUEkWLj6zqJaDS/buT3jU rWQ0WEI8G1HnTQp0cqmx9WpXDLx4n3ytRjHuHe3ND9AYE28yhfFY5baIU3UCAwEA AQKCAgAC4QrQDOTFx7c15DzszQY6yfeIBW+bRyGsDgzUgkQJCuBCvCpTrmsm9QXU zSVCDguRN8ca+3vrLjcKF2wWynM6f3NcxSM81hmrPIqLuFiwuw3/HqrYFJZW8QdC SqfWHcAtQoDkUqY4CaTU51MXgIS8PU2xsw0EK5BIWa9F5e/ULTMyhD8nx9cJZbmZ rs5bHrlIgYadvRoxNJlHq5MbaQhoLLtHEXx9EWtAuModI8mPKnrgssJKWn6z7yB9 dYjpXqfdvnyI72bCQkGOFaweyX0bXpVEyZQhPfZj+IuxNWIShADpf83N1POwvF2V 3Ugp0bgejBZA3o2pXP/S/oSG6ugh8dZHfa8vkw0x5N28393IzIMpzwE2EnsBidN1 ca7NwDpmpUyuULSpi3YoViUYY1i4Mwngv2XQdkbvoGusQwgWoNrppmDKxlL5qEBf lIPCZAgZSR79KHYw2VOzkm84hu0jDXMthpt9A2gLkRhGnGgb4n5KzyCpY9iuFK2w CO5FdjloXOjRLZb7G1JCeU6Qh0kjSE7seh9ltyo+VsWOLx4UwVOYGCMAF45yO0wF /MJdYoUt1vC5G/DK8itTTjwb/xPlGDiC441TOReWVwF6n36+shb6szlI2EmqKBkp 2Sr5xQ5VNZkcG2W/BUF7+n8Rvisu17TyW0HmwDEBDfJQzgzgpQKCAQEA7RpBNVBH Jx8gR7hQdbyi4/6U5KiYorkzuoK4KkjRWJfqJvp9uGZS2vDwOoIC8kCAXMwu3OCI U0xkDvH7bb/qedn0IG7+72FUCKlxqkMk4lv03zE9yUPcYNT+w573uh+rXQ/mcsFF +aBtupRZiDqqd4vuvjTpjw5Q4tyk/lxZfbe10S2NyxY4dZsbm8gl0SypLs/rLYjZ 8ZntRpZozIWoenrF3AnvtR114WBDpBVwSJ9KNd8xB5Fufc9TqsZ/EKPjDVrn2Sq2 Lt/xKSopwxPyIhKG1zmAeYhv8Q+GYUOQYCfBj2opDC3AOxANw2j9M8nYjCMDmPaP 5iDCUla35srp/wKCAQEA6NPj8auPGGFen2ZJoydpEPKgU3zAdv05VlKVIvbA9c+Y oy7zNhnNw0PCkkYpB9jPGvpdn6KFh2ZTU/mgmIysKriLcLN4gKho7JUCU3kvg1mv zJiz/5fR0xCCRNPLAANh6uJ+CXyssjbUoe9EmyVxKX3l2zKmy1zOKRc/FbAkql07 ItDReryb64IjsfT4GtU4nBK7zCzI+yya1BjL/McnGBcpKIwp9HCwaTQK7yxa7ThY TsfTuxoyZM1/xZE0cKRJGVLtkao1VfOy0SDdCp+RwtBvVmt3Wt6vVcL6qG0LW5Fe Uz0PN+CebMfhBCaqWXIXeuMUo+RdLnGn113Tl6i6iwKCAQEAz+NzRUGMAXtDHF84 /OJWmD1BY3OH0TU9a8ztmPWbyGf6gA6laKcfAqS6nTIdTzbK1ZKZjES6gv65xHjb ERFyj0BQ0pc/o7fcrHOVG8ofbvFdtMxB9lQvyB84+WBKqMDXyZMFZZyctBC75Rnp no6BpKvmupM+LZZJyX/YksV6GcaX/j5I0sY63rMO8/n7XnogJNFczOHu5e0mo/uB C8ItRKadER8NM+oOz3tOE3JQrvwrXyzAmngjPuAn5daA1qA7lhwcqMbQUi08D/HO CCNW7BT+cXsTcHv2WpBYLLPGxOhWyF42e10p7R9YUfud9miGG+kfYGDfLtGOUA+E 0zEbFQKCAQEA4lczDnqolpv5394RkiG6+zXTdLYfaM2NUwTfZOka9xxEl8cJuztk lAIoggjg1HcKB4EDSTA2vUVVlppjbEm9CZ70N7DRYcnWjr/hTgLOlNO4mp6Mxdny qkwvR/fZLf8bzrs2qcRhIrM5DN/NA0Jn+10f+nMIQUTMSpgFxPDDBDe0SIlWTApV TaLrTpIGLBfCe7+ef8O98qgPMEeW7vswXzQM2BVCqBZw+SUVyCOHlXukJZoPlKHI AcThBNC/eQ3M3miG+YfNZ+yMls9q82viyM/WnN3GXzmCnE37XYb8dp0gZK1EQR8F BF1fu6hXDLNkbhuZsiZMC92DvFPDYnkuNwKCAQA6/2K8PLlOeK+0p/IGVsgJpgHn Uh3BehVKHXeG/Buhn5bMXX3cB2hEHg2tz4pw3JxfZ1UflhyhKD43XnpxuMmt81Ka Ja5MeXDg0kfnlXolVA4ezx2V2EohMExUykkOIfQBDTaNtjsg5PB4HLKFId3kJ6u/ JCXuy0EA07vl/kNl+cDEBLJsVtvtxHLdpdJhO1POi3IIgOpddO+a/O/GDsdlAWog hyEb6r7+bWurjw0YjHX+R5ZQ+0XtnzXU20d2NiP/oH2IvQzXRUQ1U17Kzzn5PAhs YC7r9lRV4VjbhEi3Zk2FBPrrzs2ieXo5aHXCnzFywQ99nlrz0Ic8vV16WR1x -----END RSA PRIVATE KEY-----

Debug form

URL		Change part of the URL to /v4/payout-form/ for Payout Form integration or /v4/payout-by-ref/ for Payout By Ref integration
parameters
login		your login should be used as Consumer Public for OAuth

Normalized parameters string to sign, according to OAuth 1.0a rules

POST body parameters to submit

OAuth 1.0a headers to submit.

HEX Encoded Signature

^{* HEX encoded string is for debug purposes only. You shouldn't send this string to the server neither in HEX nor in Encoded HEX representation.}

Base64 Encoded Signature

^{* Binary RSA-SHA256 signature directly encoded in base64 should be sent to the server.}

• CURL
• PHP
• Ruby
• Java

Copy to clipboard

Copy to clipboard

Copy to clipboard

Copy to clipboard

Order status

Merchant must use Order status API call to get the customer’s order transaction status. After any type of transaction is sent to Payneteasy server and order id is returned, Merchant should poll for transaction status. When transaction is processed on Payneteasy server side it returns it’s status back to Merchant and at this moment the Merchant is ready to show the customer transaction result, whether it’s approved or declined.

Status API URL

For integration purposes use staging environment sandbox.payneteasy.com instead of production gate.payneteasy.com. Status API calls are initiated through HTTPS POST request by using URL in the following format:

The End point ID is an entry point for incoming Merchant’s transactions for single currency integration. https://gate.payneteasy.com/paynet/api/v2/status/ENDPOINTID

The End point group ID is an entry point for incoming Merchant’s transactions for multi currency integration. https://gate.payneteasy.com/paynet/api/v2/status/group/ENDPOINTGROUPID

Order status call parameters

Note

Request must have content-type=application/x-www-form-urlencoded.

Status call parameters	Description
login	Merchant login name
client_orderid	Merchant order identifier of the transaction for which the status is requested
orderid	Order id assigned to the order by Payneteasy
by-request-sn	Serial number assigned to the specific request by Payneteasy. If this field exist in status request, status response return for this specific request.
control	Checksum used to ensure that it is Payneteasy (and not a fraudster) that initiates the callback for a particular Merchant. This is SHA-1 checksum of the concatenation login + client-order-id + paynet-order-id + merchant-control. See Order status API call authorization through control parameter for more details about generating control checksum.

Order Status Response

Note

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

* - these parameters are not defined by default. Please contact tech support to include these fields in callback.

Status Response Parameter	Description
type	The type of response. May be status-response
status	See Status List for details.
amount	Amount of the initial transaction.
paynet-order-id	Order id assigned to the order by Payneteasy
merchant-order-id	Merchant order id
phone	Customer phone.
html	HTML code of 3DS authorization form, encoded in application/x-www-form-urlencoded MIME format. Merchant must decode this parameter before showing the form to the Customer. The Payneteasy System returns the following response parameters when it gets 3DS authorization form from the Issuer Bank. It contains auth form HTML code which must be passed through without any changes to the client’s browser. This parameter exists and has value only when the redirection HTML is already available. For non-3DS this never happens. For 3DS HTML has value after some short time after the processing has been started.
redirect-to	For 3DS authorization the merchant can redirect the customer to URL provided in this parameter using GET HTTP method instead of rendering the page provided in html parameter. The redirect-to parameter is returned only if the html parameter is returned. This parameter must be used to work with 3DS 2.0.
serial-number	Unique number assigned by Payneteasy server to particular request from the Merchant.
last-four-digits	Last four digits of customer credit card number.
bin	Bank BIN of customer credit card number.
card-type	Type of customer credit card (VISA, MASTERCARD, etc).
gate-partial-reversal	Processing gate support partial reversal (enabled or disabled).
gate-partial-capture	Processing gate support partial capture (enabled or disabled).
transaction-type	Transaction type (sale, reversal, capture, preauth).
processor-rrn	Bank Receiver Registration Number.
processor-tx-id	Acquirer transaction identifier.
receipt-id	Electronic link to receipt https://gate.payneteasy.com/paynet/view-receipt/ENDPOINTID/receipt-id/
name	Cardholder name.
cardholder-name	Cardholder name.
card-exp-month	Card expiration month.
card-exp-year	Card expiration year.
card-hash-id	Unique card identifier to use for loyalty programs or fraud checks.
email	Customer e-mail.
first-name	Customer’s first name
last-name	Customer’s last name
country *	Customer’s country (two-letter country code). Please see Country Codes for a list of valid country codes.
state *	Customer’s state . Please see Country Codes for a list of valid state codes. Mandatory for USA, Canada and Australia.
city *	Customer’s city
zip_code *	Customer’s ZIP code
address1 *	Customer’s address line 1
bank-name	Bank name by customer card BIN.
terminal-id	Acquirer terminal identifier to show in receipt.
paynet-processing-date	Acquirer transaction processing date.
approval-code	Bank approval code.
order-stage	The current stage of the transaction processing. See Order Stage for details
loyalty-balance	The current bonuses balance of the loyalty program for current operation. if available
loyalty-message	The message from the loyalty program. if available
loyalty-bonus	The bonus value of the loyalty program for current operation. if available
loyalty-program	The name of the loyalty program for current operation. if available
descriptor	Bank identifier of the payment recipient.
error-message	If status in declined, error, filtered this parameter contains the reason for decline
error-code	The error code is case status in declined, error, filtered.
by-request-sn	Serial number from status request, if exists in request. Warning parameter amount always shows initial transaction amount, even if status is requested by-request-sn.
verified-3d-status	See 3-D Secure Status List for details
verified-rsc-status	See Random Sum Check Status List for details
transaction-date	Date of final status assignment for transaction.

Order Status Response Example

type=status-response
&serial-number=00000000-0000-0000-0000-0000005b5044
&merchant-order-id=902B4FF5
&processor-tx-id=PNTEST-159884
&paynet-order-id=159884
&status=approved
&amount=10.42
&descriptor=test-usd
&gate-partial-reversal=enabled
&gate-partial-capture=enabled
&transaction-type=sale
&receipt-id=a5061379-6ff5-3565-a9ba-1b8a814d04f6
&name=TEST HOLDER
&cardholder-name=TEST HOLDER
&card-exp-month=1
&card-exp-year=2016
&email=john.smith@gmail.com
&last-name=Smith
&first-name=John
&processor-rrn=510321889824
&approval-code=242805
&order-stage=sale_approved
&last-four-digits=9001
&bin=520306
&card-type=MASTERCARD
&phone=12063582043
&bank-name=CITIBANK
&paynet-processing-date=2015-04-09 17:14:26 MSK
&by-request-sn=00000000-0000-0000-0000-0000005b2a8a
&card-hash-id=1493114
&verified-3d-status=AUTHENTICATED
&verified-rsc-status=AUTHENTICATED
&transaction-date=2023-01-10+12%3A46%3A28+MSK

Status request authorization through control parameter

The checksum is used to ensure that it is Merchant (and not a fraudster) that sends the request to Payneteasy. This SHA-1 checksum, the parameter control, is created by concatenating of the values of the parameters in the following order:

• login
• client_orderid
• orderid
• merchant_control

For example assume the following values are corresponds the parameters above:

Parameter Name	Parameter Value
login	cool_merchant
client_orderid	5624444333322221111110
orderid	9625
merchant_control	r45a019070772d1c4c2b503bbdc0fa22

The complete string example may look as follows:

cool_merchant56244443333222211111109625r45a019070772d1c4c2b503bbdc0fa22

Encrypt the string using SHA-1 algorithm. The resultant string yields the control parameter which is required for authorizing the callback. For the example control above will take the following value:

c52cfb609f20a3677eb280cc4709278ea8f7024c

Order status Postman Collection

Order status Debug

      by ENDPOINTID       by ENDPOINTGROUPID

endpointid or groupid		input your ENDPOINTID or ENDPOINTGROUPID
login
client_orderid		input your Invoice Number
orderid
merchant_control		input your Control Key
by-request-sn

String to sign

Signature

• CURL
• PHP
• Ruby
• Java

Copy to clipboard

Copy to clipboard

Copy to clipboard

Copy to clipboard

Server callback result

Upon completion of request processing by the System it returns the result on the specified server_callback_url with the parameters described in Merchant Callbacks

The checksum is used to ensure that the callback is initiated for a particular Merchant, and not for anybody else claiming to be such Merchant. This SHA-1 checksum, the control parameter, is created by concatenation of the parameters’ values in the following order:

• status
• orderid
• client_orderid
• merchant_control

A complete string example may look as follows:

approvedS279G323P4T1209294c258d6536ababe653E8E45B5-7682-42D8-6ECC-FB794F6B11B1

Encrypt the string using SHA-1 algorithm. The resultant string yields the control parameter. For the above-mentioned example the control will take the following value:

e04bd50531f45f9fc76917ac78a82f3efaf0049c

All parameters are sent via GET method.

For more information, see Merchant Callbacks