APIs
/
APM
/
Przelewy24

Last Updated: 08 May 2025 | Change Log

Przelewy24

Przelewy24 is a real-time bank transfer, pre-payment or offline payment method for customers based in Poland.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

Product Overview

Przelewy24 flow

Your customer is redirected to the Przelewy24 interface where they can select their bank from a list of participating banks. They will then log into their banking app where they are reviewing and approving the payment. Once completed, your customer is redirected back to the resultURL you have provided in the API request.

Feature summary

Payment typeCustomer CountryAcceptance CurrencyRecurringReversalsPartial Reversals
Bank TransferPolandPLN❌
  • Refund - yes
  • Cancel- No
  • Partial refund - yes
  • Partial cancel- No
  • Maximum transaction value: 50.000,00 PLN

Get Started

Get started using our API Reference and set your headers.

Request

POST https://try.access.worldpay.com/apmPayments

Example request

Response
application/json
{
  "paymentId": "HZ75WBkfRwmD9YzLSZFnQ--xazN30hqhileEoUF53VKlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2K6uz6RKmSmP_m7-TgEHezOhzH5eLvBJHPh6ir8ugqJqGjb7dlrQPJ4byuGHVAMZ8",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/HZ75WBkfRwmD9YzLSZFnQ--xazN30hqhileEoUF53VKlDSUrxrcX5x_wn93uYUZB26bWaGtSc4n1mbKHCn5p1tAsrh_YcN6kEXom71Xl4C2K6uz6RKmSmP_m7-TgEHezOhzH5eLvBJHPh6ir8ugqJqGjb7dlrQPJ4byuGHVAMZ8"
    }
  },
  "_actions": {},
  "redirect": "https://mock.hpp.worldpay.com/app/hpp/xyz/integration/wpg?Ticket=12345678&OrderKey=blah",
  "paymentInstrument": {
    "method": "paypal",
    "type": "redirect"
  },
  "commandId": "cmdEy5vwB0krLe9eMwAcE66c0"
}

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required
merchantobject(MerchantV2)required
merchant.​entitystring[ 1 .. 32 ] characters^([a-zA-Z0-9]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"
instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.​methodstringrequired

Type of payment method

Value"paypal"
Discriminator
instruction.​valueobject(Value)required

The value of the payment.

instruction.​value.​amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12
instruction.​value.​currencystringrequired
Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"
instruction.​narrativeobject(NarrativeBase)required
instruction.​narrative.​line1string[ 1 .. 24 ] characters^[a-zA-Z0-9\\-\\.\\,\\ ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"
instruction.​paymentInstrumentobject(PayPalInstrumentV2)required
instruction.​paymentInstrument.​typestringrequired

Type of instruction

Value"direct"
instruction.​paymentInstrument.​billingAddressobject(PayPalBillingAddressV2)
instruction.​settlementobject(Settlement)

Indicates whether the transaction should be sent for settlement now = true, or later = false at a time of your choosing.

instruction.​resultUrlsobject(ResultUrls)
instruction.​shippingobject(Shipping)
instruction.​customerobject(Customer)

Response

Successful request response

  • an HTTP code 201
  • a paymentId which is unique to the payment - we recommend storing the "id", as you can use it to manage the payment later
  • a redirect to redirect your customer to the APM provider to complete the payment
  • an link to query the payment status
  • an object which will give flow information such as method (e.g. przelewy) and type (direct)
  • a commandId generated by us identifying a single merchant interaction (e.g. cmdYNdIHBPJwbkjLiykzTx0)

Example Response

{
  "paymentInstrument": {
    "method": "przelewy",
    "type": "direct"
  },
  "paymentId": "uK9Oh5zz4yKhGuFofhhnC1loxh8YRI6ChuSe7sEy6rPwh_KRcHUrrs1qJtQso9gjbUhveud3wEUka96FeYiU0Tp38_5OaydAORxUcSiX2IyXwK6gT8PDO-IvQ-BUMt_iUsGZa3xbZdUeTuq6p3rC1PTBiR7CzE6-theYuKncW_KImK-l23r7xoTI7CEzKmR8",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/uK9Oh5zz4yKhGuFofhhnC1loxh8YRI6ChuSe7sEy6rPwh_KRcHUrrs1qJtQso9gjbUhveud3wEUka96FeYiU0Tp38_5OaydAORxUcSiX2IyXwK6gT8PDO-IvQ-BUMt_iUsGZa3xbZdUeTuq6p3rC1PTBiR7CzE6-theYuKncW_KImK-l23r7xoTI7CEzKmR8"
    }
  },
  "_actions": {},
  "redirect": "https://secure-test.worldpay.com/jsp/test/shopper/APMSTSimulator.jsp?customerRef=3442338888&paymentMethod=PRZELEWY&isPayByLink=false&serviceLevelCode=M",
  "commandId": "cmdzYfWfiJ45qbCzSK0Tvx8n0"
}

Errors

Check out our API reference for the full error code schema.

Next Steps

Manage your Przelewy payment