PayU GPO Europe REST API
type: WebAPI
description: REST API for payment processing in Central & Eastern Europe supporting order creation, refunds, payouts, tokenization, marketplace operations, and BLIK payments.
version: 2.1.0
provider: PayU
license: http://www.apache.org/licenses/LICENSE-2.0.html
terms of service: https://developers.payu.com/europe/
documentation: https://developers.payu.com/europe/docs/get-started/apis/
available channel: Production
  type: ServiceChannel
  service url: https://secure.payu.com
available channel: Sandbox
  type: ServiceChannel
  service url: https://secure.snd.payu.com
endpoint description: Create OAuth Token
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/pl/standard/user/oauth/authorize
  description: Each payment should be authorized in one of three available modes: - client_credentials - used for standard integration, - trusted_merchant - used for authentication of requ
  encoding type: application/x-www-form-urlencoded
endpoint description: Retrieve All Available Payment Methods.
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/paymethods
endpoint description: Create an Order
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/v2_1/orders
  description: Create a new order request.
  encoding type: application/json
endpoint description: Retrieve an Order
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}
  description: Retrieve the status and details of an order.
endpoint description: Cancel an Order
  type: EntryPoint
  http method: DELETE
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}
  description: Cancel (reject) orders processed by the PayU system.
endpoint description: Capture Authorized Order
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}/captures
  description: Capture whole order and update its status to COMPLETED (ended).
  encoding type: application/json
endpoint description: (deprecated) Capture Authorized Order
  type: EntryPoint
  http method: PUT
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}/status
  description: Capture an order and update its status to COMPLETED (ended).
  encoding type: application/json
endpoint description: Retrieve a Transaction
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}/transactions
  description: Retrieve the details of transactions created for an order with specified `orderId`.
endpoint description: Retrieve Shop Data
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/shops/{shopId}
  description: Retrieve your PayU shop balance, id, etc.
endpoint description: Retrieve ALL Refunds Data for the Specified Order
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}/refunds
endpoint description: Create a Refund
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}/refunds
  description: Create new refund - this request is idempotent, so if exactly same data will be provided, response will return data of already previously created refund instead of creating new refund.
  encoding type: application/json
endpoint description: Retrieve Specific Refund Data
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/orders/{orderId}/refunds/{refundId}
endpoint description: Create a Payout
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/v2_1/payouts
  description: Create a payout with the selected destination of funds.
  encoding type: application/json
endpoint description: Retrieve a Payout
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/payouts/{payoutId}
  description: Retrieve data of a specified payout.
endpoint description: Delete a Token
  type: EntryPoint
  http method: DELETE
  url template: https://secure.payu.com/api/v2_1/tokens/{token}
  description: In case the customer terminates the user account in your shop or chooses to remove the stored card from the user account, you need to delete the token.
endpoint description: Retrieve Rate Table
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/mcp-partners/{mcpPartnerId}/fx-table
  description: Retrieve current table with the conversion rates for the currencies.
endpoint description: Retrieve Reference Rates
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/fx-providers/ecb/fx-rates
  description: You can retrieve a reference rate table that is updated daily. This table encompasses rates released by the European Central Bank (ECB) against EUR, as well as additional rates that are triangulated u
endpoint description: Retrieve Seller Status
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/customers/ext/{extCustomerId}/status
  description: You can check the verification status of your submerchants.
endpoint description: Retrieve Seller Balance
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/customers/ext/{extCustomerId}/balances
endpoint description: Retrieve Seller Operation History
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/v2_1/customers/ext/{extCustomerId}/operations
endpoint description: Transfer Funds from Seller to Marketplace Balance
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/v2_1/customers/ext/{extCustomerId}/feeDebitTransfer
  encoding type: application/json
endpoint description: Transfer Funds from Marketplace to Seller Balance
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/v2_1/customers/ext/{extCustomerId}/feeCreditTransfer
  encoding type: application/json
endpoint description: Retrieve Verification Advice
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/aml-verification/v1/verification-advice
  description: Verify, on the basis of a Personal Identification Number or NIP number, whether a given individual/company has already been registered in the PayU system.
endpoint description: Retrieve Marketplace Verification Status
  type: EntryPoint
  http method: GET
  url template: https://secure.payu.com/api/aml-verification/v1/verification
  description: Retrieve the status of the verification with the specific `Id`.
endpoint description: Create Marketplace Verification
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/verification
  description: Initialize the verification process of the seller.
  encoding type: application/json
endpoint description: Add Seller's Data
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/seller
  description: This method allows to send data of the seller (submerchant).
  encoding type: application/json
endpoint description: Add Associates Data
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/associates
  description: Send the data of the associates (representatives and beneficiaries according to the relevant instructions from PayU).
  encoding type: application/json
endpoint description: Add Files
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/files
  description: Upload documents to the server.
  encoding type: application/json
endpoint description: Add Seller's Documents
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/seller/documents
  description: This method allows to load company related documents.
  encoding type: application/json
endpoint description: Add Associates Documents
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/associates/documents
  description: Upload required documents for associates (representatives or beneficiaries).
  encoding type: application/json
endpoint description: Create Order for Verification Transfer
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/verification-transfers/manual
  description: Create an order for the verification transfer service. In response you will be provided with the bank account details to make the transfer.
  encoding type: application/json
endpoint description: Add Bank Account for Payouts
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/payouts/bankAccountData
  description: Send bank account data for the payouts.
  encoding type: application/json
endpoint description: Add Payoneer Account for Payouts
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/payouts/payoneer
  description: Send bank account data for the payouts. Method is reserved for the users who have verified Payoneer account.
  encoding type: application/json
endpoint description: Add Worldfirst Account for Payouts
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/dataloading/payouts/worldfirst
  description: Send bank account data for the payouts. Method is reserved for the users who have verified Worldfirst account.
  encoding type: application/json
endpoint description: Complete Marketplace Verification
  type: EntryPoint
  http method: POST
  url template: https://secure.payu.com/api/aml-verification/v1/verification/complete
  description: Inform PayU about completing verification process.
  encoding type: application/json
endpoint description: Cancel Verification
endpoint description: Retrieve Available Installments Options
endpoint description: Retrieve Statement
endpoint description: Create a Firm
endpoint description: Create a URL for the Partner's Firm
endpoint description: Create a Shop for the Partner
endpoint description: Create POS for Partner
endpoint description: Retrieve Partner's POS Data
endpoint description: Create a User
endpoint description: Create a Submerchant
endpoint description: Retrieve Submerchant Data
endpoint description: Update Submerchant Data

Cancel Verification
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/aml-verification/v1/verification/cancel
description: Cancel verification on every step of verification providing the reason.
encoding type: application/json

Retrieve Available Installments Options
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/front/card-installments-options
description: Retrieve available card installments options for specific card. For merchants operating on the Romanian market (Requires contact with a Payu representative first).
encoding type: application/json

Retrieve Statement
type: EntryPoint
http method: GET
url template: https://secure.payu.com/api/v2_1/reports/{reportId}
description: In response to retrieving a statement via the API, PayU returns a statement file (as indicated by the `Content-Type=application/octet-stream`) in the `Content-Disposition` header. You should take this

Create a Firm
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/v2_1/firms
description: Create a Firm entity for your partner.
encoding type: application/json

Create a URL for the Partner's Firm
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/v2_1/firms/{firmId}/urls
description: Create a URL for the specified `firmId`.
encoding type: application/json

Create a Shop for the Partner
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/v2_1/firms{firmId}/shops
description: Create a Shop for the specified `firmId`.
encoding type: application/json

Create POS for Partner
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/v2_1/shops/{shopId}/poses
description: Create a POS, for your partner, for the specified `shopId`.
encoding type: application/json

Retrieve Partner's POS Data
type: EntryPoint
http method: GET
url template: https://secure.payu.com/api/v2_1/poses/{posId}
description: Retrieve data of the POS with specified `posId`.

Create a User
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/v2_1/firms/{posId}/users
description: Create an additional User for your partner.
encoding type: application/json

Create a Submerchant
type: EntryPoint
http method: POST
url template: https://secure.payu.com/api/v2_1/firms/{firmPublicId}/submerchants
encoding type: application/json

Retrieve Submerchant Data
type: EntryPoint
http method: GET
url template: https://secure.payu.com/api/v2_1/firms/{firmPublicId}/submerchants/{submerchantId}

Update Submerchant Data
type: EntryPoint
http method: PUT
url template: https://secure.payu.com/api/v2_1/firms/{firmPublicId}/submerchants/{submerchantId}
encoding type: application/json