--- title: "Create a Payout" method: POST path: "/api/v2_1/payouts" tags: ["Payout"] --- # Create a Payout `POST /api/v2_1/payouts` ## Request - Base URL: `https://secure.payu.com` - URL: `https://secure.payu.com/api/v2_1/payouts` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Create a payout with the selected destination of funds. ## Headers - `Content-Type` string, required - `Authorization` string, required ## Request body - union - StandardPayout - `shopId` string, required: Public identifier for the shop within PayU, under which payout will be executed. - `payout` object: Payout information. - `description` string: Payout description. - `extPayoutId` string, required: External identificator of Payout assigned by Merchant. Parameter must be unique within the scope of a given shop, upon encountering an error, you should use a different value. - `amount` number, required: amount for which Payout should be created - `additionalVariables` string, VS=888111: Allows sending additional information to the system (Variable Symbol). Data from this field is send only to the supporting banks. This solution is dedicated only for Czech market. - BankAccountPayout - `shopId` string, required: Public identifier for the shop within PayU, under which payout will be executed. - `payout` Payout, required: Payout information. - `description` string: Payout description. - `extPayoutId` string, required: External identificator of Payout assigned by Merchant. Parameter must be unique within the scope of a given shop, upon encountering an error, you should use a different value. - `amount` unknown, required - `additionalVariables` string, VS=888111: Allows sending additional information to the system (Variable Symbol). Data from this field is send only to the supporting banks. This solution is dedicated only for Czech market. - `foreign` string: Flag indicating whether payout was made to a foreign account. - `account` Account, required: Information about account to which payout should be sent. - `accountNumber` string, required: Bank account number. Required account formats for foreign transfers: Polish account: NRB, IBAN. Czech account: IBAN, internal in ([0-9]{1,6}[ -])?[0-9]{2,10}[ /][0-9]{4}) format. As for now, there is no format restrictions for national bank transfers. - `bankName` string: Name of the bank. Required for foreign flag set to true. - `swiftCode` string: Bank's SWIFT code. Required for foreign flag set to true. - `customerAddress` CustomerAddress, required: Payout recipient's name. - `name` string, required: Payout recipient's name. - `countryCode` string: Payout recipient's address details. Two-letter country code compliant with ISO-3166. Required for foreign flag set to true. - `city` string: Payout recipient's address details - city. Required for foreign flag set to true. - `postalCode` string: Payout recipient's address details - postal code. - `street` string: Payout recipient's address details - street. Required for foreign flag set to true. - `bankAddress` BankAddress: Bank address information. - `street` string: Bank address information - street. Required for foreign flag set to true. - `postalCode` string: Bank address information - postal code. Required for foreign flag set to true. - `city` string: Bank address information - city. Required for foreign flag set to true. - `countryCode` string: Bank address information. Two-letter country code compliant with ISO-3166. Required for foreign flag set to true. - CardPayout - `shopId` string, required: Public identifier for the shop within PayU, under which payout will be executed. - `payout` Payout, required: Payout information. - `description` string: Payout description. - `extPayoutId` string, required: External identificator of Payout assigned by Merchant. Parameter must be unique within the scope of a given shop, upon encountering an error, you should use a different value. - `amount` unknown, required - `additionalVariables` string, VS=888111: Allows sending additional information to the system (Variable Symbol). Data from this field is send only to the supporting banks. This solution is dedicated only for Czech market. - `foreign` string: Flag indicating whether payout was made to a foreign account. - `payee` Payee, required: Required section designed to limit the risk of fraud or money laundering. - `extCustomerId` string, required: Customer (payee) id assigned in the merchant system. - `accountCreationDate` string, 2025-03-27T00:00:00.000Z, required: Date when the user was created in the merchant system. - `phoneNumber` string: Customer (payee) phone number. - `email` string, required: Customer (payee) email address. - `customerAddress` CustomerAddress, required: Payout recipient's name. - `name` string, required: Payout recipient's name. - `countryCode` string: Payout recipient's address details. Two-letter country code compliant with ISO-3166. Required for foreign flag set to true. - `city` string: Payout recipient's address details - city. Required for foreign flag set to true. - `postalCode` string: Payout recipient's address details - postal code. - `street` string: Payout recipient's address details - street. Required for foreign flag set to true. - `cardToken` string: Card token representing card to which payout will be made. Required in case of a payout to the card token. - `card` CardForPayout: Data of the card that the payout will be made to. Required in case of a payout to the card number. - `number` string, required: Card number. - `expirationMonth` string, required: Card's expiration date - month. - `expirationYear` string, required: Card's expiration date - year. - `submerchant` SubmerchantForCardPayout: Submerchant information required when the card payout is created by a Payment Facilitator for the Submerchant. - `id` string, required: Submerchant ID returned by PayU during submerchant registration. - MarketplacePayout - `shopId` string, required: Public identifier for the shop within PayU, under which payout will be executed. - `account` object, required: Information about submerchant account to which payout should be sent. - `extCustomerId` string, required: Unique submerchant identifier assigned by the Marketplace. - `payout` object, required - `description` string: Payout description. - `extPayoutId` string, required: External identificator of Payout assigned by Merchant. Parameter must be unique within the scope of a given shop, upon encountering an error, you should use a different value. - `amount` unknown, required - `currencyCode` string, ISO4217, required: Shop currency from which the conversion will be made. - FxPayout - `shopId` string, required: Public identifier for the shop within PayU, under which payout will be executed. - `account` object, required: Information about submerchant account to which payout should be sent. - `extCustomerId` string, required: Unique submerchant identifier assigned by the Marketplace. - `payout` object, required - `description` string: Payout description. - `extPayoutId` string, required: External identificator of Payout assigned by Merchant. Parameter must be unique within the scope of a given shop, upon encountering an error, you should use a different value. - `amount` unknown, required - `currencyCode` string, ISO4217, required: Shop currency from which the conversion will be made. - `fxData` FxData, required: Section containing details of the payout conversion. - `partnerId` string, required: Partner id for currency exchange at PayU. - `currencyCode` 'PLN' | 'EUR' | 'CZK', ISO4217, required: Currency code after conversion. Currently supported currency codes are **PLN**, **EUR**, **CZK**. - `amount` unknown, required - `rate` unknown, required - `tableId` string, required: The ID of the exchange rate table retrieved by the merchant from PayU, determining the basis for currency conversion during payment. ## Response `201` - object - `payout` object - `payoutId` string - `extPayoutId` string - `extCustomerId` string - `amount` unknown - `currencyCode` string - `status` 'PENDING' | 'WAITING' | 'CANCELLED' | 'REALIZED' - `fxData` object - `currencyCode` string - `amount` unknown - `rate` unknown - `partnerId` string - `tableId` string - `status` object - `statusCode` string ## Other responses - `400` - `401` - `403` - `404` --- [API](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api.md) - [All operations](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payu-com/apis/payu-gpo-europe-rest-api/revisions/185e74d5e007?raw)