3.34. /api/v4/payout-by-ref/
Introduction
Payout By Reference is initiated through HTTPS POST request by using URLs and the parameters specified below. Use OAuth RSA-SHA256 for authentication.
API URLs
Integration |
Production |
---|---|
https://sandbox.payneteasy.eu/paynet/api/v4/payout-by-ref/ENDPOINTID |
https://gate.payneteasy.eu/paynet/api/v4/payout-by-ref/ENDPOINTID |
https://sandbox.payneteasy.eu/paynet/api/v4/payout-by-ref/group/ENDPOINTGROUPID |
https://gate.payneteasy.eu/paynet/api/v4/payout-by-ref/group/ENDPOINTGROUPID |
Request Parameters
Note
Parameter Name |
Description |
Value |
---|---|---|
client_orderid |
Connecting Party’s order identifier. |
Necessity : RequiredType : StringLength : 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 : RequiredType : NumericLength : 10 |
currency |
Currency the transaction is charged in (three-letter currency code). Sample values are: USD for US Dollar EUR for European Euro. |
Necessity : RequiredType : StringLength : 3 |
destination-card-ref-id |
Card reference id to destination card, obtained at Card Registration step. For the scenario of payment to a card inside the system, this card will be considered as a destination, and all processing limits, lists and fraud scoring will be applied to it as a destination card. |
Necessity : RequiredType : NumericLength : 20 |
order_desc |
Brief order description. |
Necessity : OptionalType : StringLength : 64 |
ipaddress |
Receiver’s IP address (IPv4 or IPv6). |
Necessity : ConditionalType : StringLength : 7-45 |
purpose |
Payout purpose. |
Necessity : ConditionalType : StringLength : 128 |
server_callback_url |
URL the transaction result will be sent to. Connecting Party may use this URL for custom processing of the transaction completion, e.g. to collect sales data in Connecting Party’s database. See more details at Connecting Party Callbacks. |
Necessity : OptionalType : StringLength : 128 |
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.eu 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 : OptionalType : StringLength : 128 |
redirect_success_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.eu 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 : OptionalType : StringLength : 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.eu if there is no need to redirect Receiver anywhere. Use either combination of redirect_fail_url and redirect_success_url or redirect_url, not both.
|
Necessity : OptionalType : StringLength : 1024 |
account_number |
Account Number. |
Necessity : ConditionalType : StringLength : 24 |
account_name |
Bank account. |
Necessity : OptionalType : StringLength : 128 |
ewallet_type |
Type of e-wallet. |
Necessity : ConditionalType : StringLength : 64 |
ewallet_wallet |
E-wallet ID. |
Necessity : ConditionalType : StringLength : 128 |
crypto_wallet_address |
Address of crypto wallet. |
Necessity : ConditionalType : StringLength : 64 |
bank_name |
Bank Name. |
Necessity : ConditionalType : StringLength : 255 |
bank_branch |
Bank Branch Name. |
Necessity : ConditionalType : StringLength : 255 |
bank_code |
Bank code. |
Necessity : ConditionalType : StringLength : 32 |
bank_city |
Bank city. |
Necessity : ConditionalType : StringLength : 128 |
bank_address1 |
Bank address. |
Necessity : ConditionalType : StringLength : 255 |
bank_zip_code |
Bank postal ZIP code. |
Necessity : ConditionalType : StringLength : 255 |
bank_province |
Bank province. |
Necessity : ConditionalType : StringLength : 255 |
bank_area |
Bank area. |
Necessity : ConditionalType : StringLength : 255 |
routing_number |
Routing number used to identify specific bank branches in China. |
Necessity : ConditionalType : StringLength : 16 |
legal_person_name |
Name on the legal document. |
Necessity : ConditionalType : StringLength : 128 |
legal_person_document_number |
Number of legal document. |
Necessity : ConditionalType : StringLength : 128 |
receiver_first_name |
Receiver first name, also can be sent as first_name. |
Necessity : ConditionalType : StringLength : 128 |
receiver_last_name |
Receiver last name, also can be sent as last_name. |
Necessity : ConditionalType : StringLength : 128 |
receiver_birthday |
Receiver birthday, also can be sent as birthday. |
Necessity : ConditionalType : NumericLength : 30 |
receiver_country_code |
Receiver country code, also can be sent as country. |
Necessity : ConditionalType : StringLength : 3 |
receiver_state |
Receiver state, should be provided for countries that have states (USA, Canada, Australia), also can be sent as state. |
Necessity : ConditionalType : StringLength : 4 |
receiver_city |
Receiver city, also can be sent as city. |
Necessity : ConditionalType : StringLength : 128 |
receiver_zip_code |
Receiver zip code, also can be sent as zip_code. |
Necessity : ConditionalType : NumericLength : 32 |
receiver_address1 |
Receiver address, also can be sent as address1. |
Necessity : ConditionalType : StringLength : 256 |
receiver_phone |
Receiver phone, also can be sent as phone. |
Necessity : ConditionalType : NumericLength : 128 |
receiver_email |
Receiver E-mail, also can be sent as email. |
Necessity : ConditionalType : StringLength : 128 |
receiver_identity_document_id |
Receiver identity document identifier, also can be sent as identity_document_id. |
Necessity : ConditionalType : StringLength : 128 |
receiver_identity_document_number |
Receiver identity document number, also can be sent as identity_document_number. |
Necessity : ConditionalType : StringLength : 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 Callback. |
Necessity : OptionalType : StringLength : 64k |
bank_bic |
BIC of the receiver’s bank. |
Necessity : OptionalType : StringLength : 128 |
receiver_inn |
Receiver’s INN. |
Necessity : OptionalType : StringLength : 128 |
customer_level |
Customer level in CMS system |
Necessity : OptionalType : VarcharLength : 32 |
customer_id |
Customer ID in CMS system. Necessity becomes required if transaction goes via CMS (PNE) |
Necessity : OptionalType : IntLength : 10 |
merchant_customer_identifier |
Merchant Customer ID in CMS system. Necessity becomes required if transaction goes via CMS (CRM) |
Necessity : OptionalType : VarcharLength : 64 |
card-ref-id |
Card reference ID used in subsequent recurring payments. Card reference ID creation is initiated through HTTPS POST request by using URLs and the parameters specified below. Use OAuth RSA-SHA256 for authentication. |
Necessity : ConditionalType : Long |
* Ask Support Manager if Conditional fields are Required for integration.
Response Parameters
Note
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 |
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. |
Request Example
POST /paynet/api/v4/payout-by-ref/121799 HTTP/1.1
Host: sandbox.payneteasy.eu
User-Agent: curl/8.4.0
Accept: */*
Authorization: OAuth oauth_consumer_key="ErwinTestMerchant", oauth_nonce="8qsDrhiDelGHlxY01aDjCh44u7isXJjL", oauth_signature="WpbNcRxNSDW%2BdJgftRc%2BAN0oe8KAP4CNpUkxjxStFYZEU9Vo%2F7uk9dSKEG%2B76C%2FdlzemILaRmikQqZg93ZK1cibT8zy97uYVDdWVmY2obDSOVb8UipGjt2KFUyKr4awHW9xH%2BTzbR%2FMXwm3y%2Fx2RotElZWxumsL37P5Q%2BCquoAGcO6jjkvkkSH9P4lBYKSmwhfqD4O%2Br8FB3exzNzl2FFBTwLp4ch2G9Cis5a0CkVrpjDB%2FbbbrOutbNPZYhtH45rNz91QAbpvNJ91XjVwxiCm4lCldIO66gF73GQNSFKVG1mstc%2B941Dj1bVhXWQQW%2F9TyPiXfWGP8szg18rwsTHbj1zKCRIaw%2FqVbrOBPhbo%2BJjGMZp2hB1ei0%2FUPIkjeIZkWD2NgJRQEniJfjU7AlILs91augm50fPwWR5JiOuE5uSvwM6VWgXMpYe4USb819ZAK%2BFYTRI%2BenrycFZHmY%2BafOlaOHFtpnbn8FsrzzNbOvGXmXCt2xXAQTaORqMeLRRtkD3DY4rJa8qeO0zYnmT4ZhKsFZjImDdonA3WTG8G7awP9W0RKhHlUGwGaugRWbdPjSbGMhAzs58Y9ptvExr6GwAHhJU1RbzfWL4wCzVbH8%2BAC6I0OrkB13tw2eXP4yIPtEC7iGu%2FkElGz4OrwFEU6cUcEDpeEOmA2%2Fe%2BZFK0w%3D", oauth_signature_method="RSA-SHA256", oauth_timestamp="1721975900", oauth_version="1.0"
Content-Length: 74
Content-Type: application/x-www-form-urlencoded
Connection: keep-alive
amount=10.42
&client_orderid=1
¤cy=USD
&destination-card-ref-id=1461897
Success Response Example
HTTP/1.1 200
Server: server
Date: Fri, 26 Jul 2024 06:39:23 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: 138
type=async-response
&serial-number=00000000-0000-0000-0000-000002f36e41
&merchant-order-id=1
&paynet-order-id=7363634
&end-point-id=121799
Fail Response Example
HTTP/1.1 200
Server: server
Date: Fri, 26 Jul 2024 06:42:43 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: 170
type=validation-error
&serial-number=00000000-0000-0000-0000-000002f36e42
&error-message=Project+with+currency+USD+does+not+apply+request+with+currency+AZN
&error-code=16
Postman Collection
Request Builder
Insert PKCS#1 PEM private key for sandbox environment in the field below. Request builder supports up to 4096 key length.
Debug form
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 |
---|
Base64 Encoded Signature |
---|
|