Skip to content

Last updated: 20 February 2026 | Change log

Swish is a popular mobile payment method in Sweden and is widely used for e-commerce transactions. It allows your customers to make real-time payments using the Swish mobile app and Swedish BankID mobile app.

Note

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

Product overview

Feature summary

Payment typeCountryAcceptance currencyRecurringReversalsPartial reversalsAuth and settlement (sale)
Digital walletSwedenSEK
  • Refund - yes
  • Cancel - no
  • Partial refund - yes
  • Partial cancel - no

Transaction value:

  • minimum transaction SEK 0,01
  • maximum transaction SEK 150.000,00

Customer journey

Prerequisite

Your customer must have both the Swish mobile app and the BankID app installed on their phone.

Payment flow

Your customers can invoke a payment in two ways:

With their phone number

Used in:

  • a web browser to Swish app flow
  1. Submit your payment request and receive a synchronous response with the order status "pending".
  2. The Swish app automatically pops up and your customer proceeds to pay.
  3. We send you an asynchronous notification of the payment outcome.

Without their phone number

Used in:

  • a web browser to Swish app or
  • a merchant mobile app to Swish app flow
  1. Submit your payment request and receive a synchronous response with the order status "pending".
  2. You also receive a transactionCode and a redirect Base64 code in your response. Add the value of the transactionCode in the token of the Swish app URL.
    • For web browser initiated payments - use the Base64 encrypted code to display a QR code. Your customer can scan this code on a separate device to prompt it to open their Swish app and complete the payment
      or
    • For merchant mobile app payments - add the value of the transactionCode in the token of the Swish app URL. This will prompt your customer's app to open where they can complete the payment.
  3. We send you an asynchronous notification of the payment outcome.

For more information on how to trigger the Swish app, please refer to Swish's developer guide.

Get started

Use our API reference and set your headers.


Request

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

Example request

application/json
{ "transactionReference": "apm-order-12345686564", "orderReference": "apm-order-12345", "merchant": { "entity": "default" }, "instruction": { "method": "swish", "value": { "amount": 250, "currency": "SEK" }, "narrative": { "line1": "Mind Palace" }, "paymentInstrument": { "type": "direct", "country": "SE" }, "customer": { "phone": "46761985401" } } }

Parameters

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

For Bizum transaction please follow this extra regex [a-zA-Z0-9]{4,12}

orderReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$

A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:

  • the total amount for a single order is split across multiple payments
  • you use a single reference for each payment in a recurring agreement or split shipment scenario
merchantobject(MerchantV2)required
merchant.​entitystring[ 3 .. 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"ach"
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(AchEftPaymentInstrumentV2)required
instruction.​paymentInstrument.​typestringrequired

The type of instrument.

Value"direct"
instruction.​paymentInstrument.​accountTypestringrequired

Account type.

Enum"checking""savings""corporate""corporateSavings"
Example: "checking"
instruction.​paymentInstrument.​accountNumberstring[ 1 .. 17 ] characters^[0-9]*$required

Account number of direct debit account.

Example: "123456789"
instruction.​paymentInstrument.​routingNumberstring= 9 characters^[0-9]*$required

Routing number of direct debit account.

Example: "123456789"
instruction.​paymentInstrument.​checkNumberstring[ 1 .. 15 ] characters^[0-9]*$

Check number of the direct debit account.

Example: "123456789"
instruction.​paymentInstrument.​companyNamestring[ 1 .. 40 ] characters^[0-9]*$

Company name if a corporate account.

Example: "123456789"
instruction.​paymentInstrument.​billingAddressobject(AchEftBillingAddress)required
instruction.​paymentInstrument.​billingAddress.​address1string[ 1 .. 80 ] characters
instruction.​paymentInstrument.​billingAddress.​address2string[ 1 .. 80 ] characters
instruction.​paymentInstrument.​billingAddress.​address3string[ 1 .. 80 ] characters
instruction.​paymentInstrument.​billingAddress.​citystring[ 1 .. 50 ] characters

City.

instruction.​paymentInstrument.​billingAddress.​countryCodestring
Enum"AD""AE""AF""AG""AI""AL""AM""AN""AO""AQ"
instruction.​paymentInstrument.​billingAddress.​postalCodestring[ 1 .. 15 ] characters

Postal code.

instruction.​paymentInstrument.​billingAddress.​statestring[ 1 .. 30 ] characters

State code of the billing address in ISO 3166-2 format.

Example: "US-OH"
instruction.​customerobject(CustomerDetailsAch)required
instruction.​customer.​firstNamestring[ 1 .. 22 ] charactersrequired

Your customer's first name.

instruction.​customer.​lastNamestring[ 1 .. 22 ] charactersrequired

Your customer's last name.

instruction.​customer.​customerIdstring<= 15 characters^[a-zA-Z0-9]*$

Your unique reference for the customer so that the 'pay faster next time' function can be used during checkout. This allows your customer's chosen bank to be stored for their next payment.

Example: "44528abcd"
instruction.​customer.​emailstring

The customer's e-mail address.

Example: "customer@worldpay.com"

Response

Example response

{
  "paymentInstrument": {
    "method": "swish",
    "type": "direct"
  },
  "paymentId": "eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdKgIbll24WbW4bjxcOFkvbpJNnd51Q+QyfiGaiRe9nbKem66NOYspir3PJsMwGsI7G2Bf+rspiXLfF0Zn4xovsnjKIKWBW6p+Rdq:C8bzvzksHpCpFZQGSv0Xc:8EsM3P954rfT6hMMjSKiEe6HkFm97Tdqnh0cTWck:wh0Mvah:KtGknckWds:wrjcUMQshbQQ6sGi9VYvEB5k55y2sensiXY0Yl+:o+DhIRXOVuFuodpucFGzoapJG7KB6E+glKvLwdJZEx5MYoCT6G5d8JewNuyzINJ9Ct0Fd1CqhIA8jMh:ad9A+8L5w0NQE0YQtKA==",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.BnnxxcMle38OazhwbF8J+4rtJi8CAq:Y3zUOn1dw6VWfvx:PHL5L0S+5ara5vz6ouV5yBmVUQCiSwQjs+1x5qJIJxAKWMWc2Mlb1doricEYlzsZIRIGCflvnYu1Ns8g1S0+66n6wCELiB9OHfX7cdKgIbll24WbW4bjxcOFkvbpJNnd51Q+QyfiGaiRe9nbKem66NOYspir3PJsMwGsI7G2Bf+rspiXLfF0Zn4xovsnjKIKWBW6p+Rdq:C8bzvzksHpCpFZQGSv0Xc:8EsM3P954rfT6hMMjSKiEe6HkFm97Tdqnh0cTWck:wh0Mvah:KtGknckWds:wrjcUMQshbQQ6sGi9VYvEB5k55y2sensiXY0Yl+:o+DhIRXOVuFuodpucFGzoapJG7KB6E+glKvLwdJZEx5MYoCT6G5d8JewNuyzINJ9Ct0Fd1CqhIA8jMh:ad9A+8L5w0NQE0YQtKA=="
    }
  },
  "_actions": {},
  "redirect": "",
  "commandId": "cmdzKbxhkiOS0VzNtzZ4XPKd0",
  "transactionCode": "BCD2ABDD76D934A093D679B39305F4CC"
}

Schema

paymentIdstring

The identifier of the payment resource.

lastEventstring
Enum"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"
_linksobject(Links)

Links to resources related to the request.

_actionsobject(Actions)
redirectstring

The URL to redirect your customer to, or a QR code in Base64 to show to your customer, in order to complete the transaction.

paymentInstrumentobject(PaymentInstrumentResponse)
commandIdstring

An action ID generated by us identifying a single merchant interaction

Example: "cmdYNdIHBPJwbkjLiykzTx0"
transactionCodestring

For Pix payments - display to your customer for them to copy and paste in the Pix app.

For Swish payments - use this value and add in the custom URL scheme: swish://paymentrequest?token={token}&callbackurl={callbackURL} as the token value. This will prompt the app to open where the customer can complete their payment.

Example: "IZQ3iUfePwiWiwldJlipl8NGVA7w5IUg"

Errors

Check out our API reference for more responses or error codes.

Simulation

To simulate payment outcomes and trigger webhooks in our Try environment you can send a request prompting our simulator.

Request example

  {
    "transactionReference": "apm-order-12345686564",
    "orderReference": "apm-order-12345",
    "merchant": {
      "entity": "default"
    },
    "instruction": {
      "method": "swish",
      "value": {
        "amount": 250,
        "currency": "SEK"
      },
      "narrative": {
        "line1": "Mind Palace"
      },
      "paymentInstrument": {
        "type": "direct",
        "country": "SE"
      },
      "customer": {
        "phone": "46761985401"
      },
      "resultUrls": {
        "cancel": "https://worldpay.com/cancel",
        "failure": "https://worldpay.com/failure",
        "pending": "https://worldpay.com/pending",
        "success": "https://worldpay.com/success"
      }
    }
  }

You receive a redirect link to our simulator where you can choose different payment outcomes:

Simulator outcome optionPayment statusDescription
AuthorisedauthorizedPayment authorized successfully.
Authorised and CapturedsentForSettlementPayment authorized successfully and your customer's funds received.
RefusedrefusedUnsuccessful payment - failure response from the provider.
ErrorerrorError in processing the payment or the session timed out.
Shopper CancelledcancelledYour customer cancelled the transaction.

Response example

{
  "paymentInstrument": {
    "method": "swish",
    "type": "direct"
  },
  "paymentId": "eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.dz5mM2S9wOJFy0F+xZ63pJoY4MvCJmVKVX5RXy1cWGhFcthsPs91vvKMH5zN1RgFR8SWBDRoQFA4GRUVGjxZCWsfqOLqZzb6KliNHM8rs0EMWSqklWHSogj5rZUH5kI3mebsBdksBOwHzOsi0K3NiY8wPy4CC+yuF2EzgrSjuKziwMRCCwsuKTgtCsDJY8do1hSDGeuhROmq+2BRwnDNvqxYcKtB1glrP9vZvweaGUYlVmX:rRtVY6:28WjlC8gvMDOsjoSlYnakcWAuIzwPZHPJkiyF:wEF3YiNB5b3aCTlge8GFB1uN1hkZLUOvvRtC7:ixYgCBrgJwbIOdFEcyfZWmiQjryMZfDVJr2F9Q97OAXA8tipQVZMxWYn0h5J+jtJi8kjOjGi5o7hGAwVfQixoV05C3nz0vYVPKJXVqmM=",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/eyJrIjoiYXBtLXNlcnZpY2UtZGVmYXVsdCIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.dz5mM2S9wOJFy0F+xZ63pJoY4MvCJmVKVX5RXy1cWGhFcthsPs91vvKMH5zN1RgFR8SWBDRoQFA4GRUVGjxZCWsfqOLqZzb6KliNHM8rs0EMWSqklWHSogj5rZUH5kI3mebsBdksBOwHzOsi0K3NiY8wPy4CC+yuF2EzgrSjuKziwMRCCwsuKTgtCsDJY8do1hSDGeuhROmq+2BRwnDNvqxYcKtB1glrP9vZvweaGUYlVmX:rRtVY6:28WjlC8gvMDOsjoSlYnakcWAuIzwPZHPJkiyF:wEF3YiNB5b3aCTlge8GFB1uN1hkZLUOvvRtC7:ixYgCBrgJwbIOdFEcyfZWmiQjryMZfDVJr2F9Q97OAXA8tipQVZMxWYn0h5J+jtJi8kjOjGi5o7hGAwVfQixoV05C3nz0vYVPKJXVqmM="
    }
  },
  "_actions": {},
  "redirect": "https://secure-test.worldpay.com/jsp/test/shopper/APMSTSimulator.jsp?customerRef=3494243302&paymentMethod=SWISH",
  "commandId": "cmdFhJbQqGcS5PbZO-gv26qP0",
  "transactionCode": ""
}

Next steps

Manage your Swish payment