Payment methods

GET 
/v3/payments/paymentmethods

Retrieve all available payment methods for payments.

Request

Query Parameters

amount integer

Amount query parameter used for filtering available payment methods

currency Currency
Possible values: [PLN, EUR, USD, GBP, CZK]
Currency query parameter used for filtering available payment methods
Default value: PLN
applePayEnabled boolean
Query parameter used for filtering Apple Pay payment method based on availability checked in browser.
Default value: true

Header Parameters

Signature stringrequired

The Signature header is used to ensure the request’s body integrity and to confirm that its content has not changed.

User-Agent string

The User-Agent request header contains a characteristic string that allows the network protocol peers to identify the application type, operating system, software vendor or software version of the requesting software user agent.

Accept stringrequired

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand. Can be set to */*.

Responses

200

Success

application/json

Schema

Schema

• Array [

type string

Type of method used for payment

Possible values: [APPLE_PAY, BLIK, CARD, ECOMMERCE, GOOGLE_PAY, PAYPO, PBL]

paymentMethods

object[]

Array [

id integerrequired

Unique identifier of payment method

name stringrequired

Short name of payment method

description stringrequired

Description of payment method

image stringrequired

Url for payment method icon

status stringrequired

Current status of payment method

Possible values: [ENABLED, DISABLED]

authorizationType stringrequired

Authorization type. In case of REDIRECT the payment authorization happens on Paynow site. In case of CODE the Payment Request sent to Paynow needs to contain the authorizationCode

Possible values: [REDIRECT, CODE]

]

• ]

Example (from schema)

[
  {
    "type": "PBL",
    "paymentMethods": [
      {
        "id": 1000,
        "name": "mTransfer",
        "description": "Zapłać przez mTransfer",
        "image": "https://static.sandbox.paynow.pl/payment-method-icons/1000.png",
        "status": "ENABLED",
        "authorizationType": "REDIRECT"
      }
    ]
  }
]

400

Bad request

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [CONFLICT, FORBIDDEN, NOT_FOUND, RATE_LIMIT_REACHED, SYSTEM_TEMPORARILY_UNAVAILABLE, UNAUTHORIZED, VALIDATION_ERROR, VERIFICATION_FAILED, PAYMENT_METHOD_NOT_AVAILABLE, PAYMENT_AMOUNT_TOO_SMALL, PAYMENT_AMOUNT_TOO_LARGE, IDEMPOTENCY_KEY_MISSING, SIGNATURE_MISSING]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "CONFLICT",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 400,
  "errors": [
    {
      "errorType": "VALIDATION_ERROR",
      "message": "Missing field XXX"
    },
    {
      "errorType": "VALIDATION_ERROR",
      "message": "Invalid format of field YYY"
    }
  ]
}

401

Unauthorized, invalid or missing credentials

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

oneOf

UnauthorizedErrorDetails

errorType stringrequired

Error type

Possible values: [UNAUTHORIZED]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {}
  ]
}

Example

{
  "statusCode": 401,
  "errors": [
    {
      "errorType": "UNAUTHORIZED",
      "message": "Unauthorized, invalid or missing credentials"
    }
  ]
}

404

Not found

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [NOT_FOUND]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "NOT_FOUND",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 404,
  "errors": [
    {
      "errorType": "NOT_FOUND",
      "message": "Resource not found"
    }
  ]
}

500

Internal server error

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [INTERNAL_SERVER_ERROR]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 500,
  "errors": [
    {
      "errorType": "INTERNAL_SERVER_ERROR",
      "message": "Internal server error"
    }
  ]
}

503

Service is temporarily unavailable

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

Error type

Possible values: [SYSTEM_TEMPORARILY_UNAVAILABLE]

message string

Error description

]

Example (from schema)

{
  "statusCode": 0,
  "errors": [
    {
      "errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
      "message": "string"
    }
  ]
}

Example

{
  "statusCode": 503,
  "errors": [
    {
      "errorType": "SYSTEM_TEMPORARILY_UNAVAILABLE",
      "message": "Service is temporarily unavailable"
    }
  ]
}

Loading...