Payouts

The client authenticates by OAuth standard by downloading a token, which is used to create the payout and download its status.

Authentication data can be found in client panel.

Note: you need to have POS in the REST API (Checkout) type.

Data is visible under: My Shops -> Shop details -> Point of sales -> Details:

• client_id: POS ID (OAuth protocol - client_id)
• client_secret: Key MD5 (OAuth protocol - client_secret)

User can get authentication token using OAuth standard. Token is necessary to have access to Payout API. See:

Downloading the authorization token.

Both available methods (creating a payout and downloading payout data) are authorized by adding the header:

                Authentication: Bearer [access_token]
            

Bearer means OAuth authentication, access_token is token received in response to the OAuth service, see section 1.2.

The payment is made to the bank account defined at the level of the Shop or the Company.

Specification of message which create payout:

Every request should contain the authorization header shown in section 1.3 and the definition of the type of transmitted data Content-Type application/json.

Payout of the given amount:

                curl -X POST https://secure.payu.com/api/v2_1/payouts \
                -H "Content-Type: application/json" \
                -H "Authorization: Bearer 3e5cac39-7e38-4139-8fd6-30adc06a61bd" \
                -d '{  
                    "shopId": "n7Cd7y1U",  
                    "payout": 
                    {    
                        "amount": 1100  
                    }
                }'
            

In particular, if the store wants to make a full payout of all available funds, is sufficient to send an HTTP request containing only the shopId to the following URL:

Authentication methods are described in: Signing API calls parameters.

http://secure.payu.com/api/v2_1/payouts

Payout of the full amount:

                curl -X POST https://secure.payu.com/api/v2_1/payouts \
                -H "Content-Type: application/json" \
                -H "Authorization: Bearer 3e5cac39-7e38-4139-8fd6-30adc06a61bd" \
                -d '{
                     "shopId": "n7Cd7y1U"
                 }'
            

The remaining data will be supplemented with information stored in PayU.

Payout with Variable symbol:

                curl -X POST https://secure.payu.com/api/v2_1/payouts \
                -H "Content-Type: application/json" \
                -H "Authorization: Bearer 3e5cac39-7e38-4139-8fd6-30adc06a61bd" \
                -d '{  
                    "shopId": "n7Cd7y1U",  
                    "payout": 
                    {    
                        "amount": 1100,
                        "additionalVariables": "VS=888111"  
                    }
                }'
                
            

Example of response:

                {
                  "payout": {
                    "payoutId": "133bfe5f400e4b2c8da44abfdf753d79",
                    "extCustomerId": "123123",
                    "status": "PENDING"
                  },
                  "status": {
                    "statusCode": "SUCCESS"
                  }
                }
                
            

Response fields description:

A payment to a designated bank account can be ordered at:

• a domestic bank account
• a foreign bank account
• as a mail transfer order (only for Polish stores),

which affects the scope of information transferred in the input message. Validation of the input range for payouts to a given bank account is completely different than the standard Payout.

Warning! The creation of a payout that indicate the bank account is available only for the stores that meet the verification criteria. To start the verification process contact us through our contact page.

Specification of the message creating the payout to the designated bank account:

Specification of respone message:

Every request should contain the authorization header shown in section 1.3 and the definition of the type of transmitted data Content-Type application/json.

Payout to a domestic bank account:

                curl -X POST https://secure.payu.com/api/v2_1/payouts \
                -H "Content-Type: application/json" \
                -H "Authorization: Bearer 3e5cac39-7e38-4139-8fd6-30adc06a61bd" \
                -d '{  
                    "shopId":"n7Cd7y1U",  
                    "payout": {    
                        "amount":"1000",    
                        "description":"Some payout"  
                    },  
                    "account": {    
                        "accountNumber":"59114072854040477132976504"  
                    },  
                    "customerAddress": {    
                        "name":"Stefan Jaracz"  
                    }
                }'         
            

Authentication methods are described in: Signing API calls parameters.

Payout to a foreign bank account with the use of SWIFT code and bank name:

                curl -X POST https://secure.payu.com/api/v2_1/payouts \
                -H "Content-Type: application/json" \
                -H "Authorization: Bearer 3e5cac39-7e38-4139-8fd6-30adc06a61bd" \
                -d '{ 
                    "shopId":"n7Cd7y1U",
                    "payout": {
                        "amount":"1000",
                        "description":"Some foreign payout",
                        "foreign":"true"
                    },
                    "account": {
                        "accountNumber":"DE610639036594575851447918096101",
                        "swiftCode":"AARBDE5W700",
                        "bankName":"Aareal Bank"
                    },
                    "customerAddress": {
                        "street":"RICHARD STRAUSS STRASSE 24",
                        "city":"MUENCHEN",
                        "countryCode":"DE",
                        "name":"Steffen von Klaus"
                    }
                }'
            

To get the payout data please send an HTTP GET request to the URL constructed in the following way:

http://secure.payu.com/api/v2_1/payouts/{payoutId}

payoutId is a public payout identifier returned in response to the request for the payout creation.

Note: payout data retrieve is limited to last 2 weeks.

Specification of the message retrieving payout data:

Every request should contain the authorization header shown in section 1.3 and the definition of the type of transmitted data Content-Type application/json.

Request example:

                curl -X GET https://secure.payu.com/api/v2_1/payouts/133bfe5f400e4b2c8da44abfdf753d79 
                -H "Content-Type: application/json" 
                -H "Authorization: Bearer 3e5cac39-7e38-4139-8fd6-30adc06a61bd"
            

Response example:

                {
                  "payout": {
                    "payoutId": "133bfe5f400e4b2c8da44abfdf753d79",
                    "amount": "1100",
                    "description": "Billing: 169602484",
                    "status": "PENDING"
                  },
                  "status": {
                    "statusCode": "SUCCESS"
                  }
                }                
            

Example of response on request with wrong data:

                {
                  "status": {
                    "statusCode": "DATA_NOT_FOUND",
                    "severity": "ERROR",
                    "code": "8354",
                    "codeLiteral": "INCORRECT_MERCHANT_POS",
                    "statusDesc": "INCORRECT_MERCHANT_POS"
                  }
                }               
            

Specification of the status section of the response message:

Error codes in message processing are sent in response messages in the status section.