Create a payment

POST 
/v3/payments

To create a payment, you use a payment resource. It's a reference to the actual payment that happens at the payment gateway.

Request

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.

Idempotency-Key stringrequired

Possible values: <= 45 characters

A unique identifier used to ensure idempotent behavior. If the business application request fails or you receive a timeout you can retry the request with the same Idempotency-Key to guarantee that only one business object is created.

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 */*.

Content-Type stringrequired

The Content-Type entity header is used to indicate the media type of the resource.

application/json

Body

amount int64required

Possible values: <= 10 characters, >= 100 and <= 100000000

A positive integer in the smallest currency unit between 1.00PLN and 1,000,000.00PLN.

currency Currency (string)

Possible values: [PLN, EUR, USD, GBP, CZK]

Default value: PLN

Important: Currently EUR,USD,GBP,CZK currencies are supported only for card payments.

If you are interested in processing card payments in foreign currencies, please contact us at support@paynow.pl

externalId stringrequired

Possible values: <= 100 characters

Unique identifier given by Merchant to this payment request

description stringrequired

Possible values: <= 255 characters

Payment description displayed in the web interface

continueUrl string

Possible values: <= 1000 characters

The URL that the buyer will be redirected to, after making payment. This URL overrides return_url value from PoS configuration

buyer

object

required

Information about the buyer

email emailrequired

Possible values: <= 50 characters

Buyer's e-mail address

firstName string

Possible values: <= 50 characters

Buyer's first name

lastName string

Possible values: <= 50 characters

Buyer's last name

phone

object

Phone number with country calling code

prefix stringrequired

Possible values: <= 5 characters

Must consist of 1-4 digits preceded by a plus (+) character

number integerrequired

Possible values: <= 10 characters

address

object

Buyer's billing and shipping addresses. Required to initiate PayPo payment.

billing

object

street string

Possible values: <= 100 characters, >= 1

houseNumber string

Possible values: <= 16 characters

apartmentNumber string

Possible values: <= 16 characters

zipcode string

Possible values: <= 10 characters, >= 1, Value must match regular expression ^[A-Z0-9-_ ]+$

city string

Possible values: >= 2 characters and <= 100 characters

county string

Possible values: <= 50 characters

country string

Possible values: >= 2 characters and <= 2 characters

Country code (ISO 3166-1 alfa-2)

shipping

object

street string

Possible values: <= 100 characters, >= 1

houseNumber string

Possible values: <= 16 characters

apartmentNumber string

Possible values: <= 16 characters

zipcode string

Possible values: <= 10 characters, >= 1, Value must match regular expression ^[A-Z0-9-_ ]+$

city string

Possible values: >= 2 characters and <= 100 characters

county string

Possible values: <= 50 characters

country string

Possible values: >= 2 characters and <= 2 characters

Country code (ISO 3166-1 alfa-2)

locale string

Possible values: <= 35 characters

Default value: pl-PL

Buyer's language tag compliant with BCP47/RFC5646.

externalId string

Possible values: <= 100 characters

Buyer's external system identifier

deviceFingerprint string

Fingerprint of Buyer’s device. See what should be included here

orderItems

object[]

List of order items

Array [

name stringrequired

Possible values: <= 120 characters

Item`s name

producer string

Possible values: <= 120 characters

Producer`s name

category stringrequired

Possible values: <= 1000 characters

Item`s category

quantity int64required

Possible values: <= 10 characters

Quantity

price int64required

Possible values: <= 10 characters

Single item price in the smallest currency unit

]

validityTime integer

Possible values: >= 60 and <= 864000

Timeout for transaction execution [seconds]

payoutAccount string

Possible values: <= 30 characters

Payout account for Mass Collect, overriding default payout account; required only in Mass Collect payments

Responses

201

Created

application/json

Schema

Schema

redirectUrl string

Address to redirect the buyer in case of authorizing payment on provider site

paymentId paymentIdrequired

Unique ID of a payment generated by Paynow

status string

Possible values: [NEW, PENDING, ERROR]

Status of the payment right after submitting a payment request. More information you can find here.

Example (from schema)

{
  "redirectUrl": "https://api.sandbox.paynow.pl/PBLX-123-435-213?token=......",
  "paymentId": "PBLX-123-435-213"
}

400

Bad request

application/json

Schema

Schema

statusCode integerrequired

Error status code

errors

object[]

required

Array [

errorType stringrequired

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]

Error type

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

Possible values: [UNAUTHORIZED]

Error type

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

Possible values: [NOT_FOUND]

Error type

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

Possible values: [INTERNAL_SERVER_ERROR]

Error type

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

Possible values: [SYSTEM_TEMPORARILY_UNAVAILABLE]

Error type

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...