Purpose

This method initiates payment session for a customer (purchase) use in other IPC Calls. 

 

 

myPOS Checkout API will check for:

  • Valid myPOS Account number (also referred to as Client number)
  • Valid Checkout Store ID corresponding with this myPOS Account number
  • Valid status of the Checkout (enabled)
  • Valid currency and total amount
  • Valid KeyIndex & corresponding Signature 

 

Method properties

Property

Typical value

Type

Required

Description

OrderID

20120331999999

String

YES

Placeholder for the merchant. Used to put some data that will help the merchant to recognize for which order is the payment. Up to 255 characters.

Amount

23.45

Double

YES

The amount of payment requested.

Currency

EUR

A(3)

YES

ISO 3-character currency code. The currency for the payment should be registered and approved.

SID

000000000000010

String

YES

Store ID (SID) - Reference number for the Merchant Store in the myPOS system

WalletNumber

61938166610

String

YES

myPOS Client Number

KeyIndex

 1

Int

YES

Indicates which key pair is being used.

RequestToken

0

N(1)

NO

0 – Do not request a payment card token

1 – Pay with a card and request a token.

 

Token will be available in IPCPurchaseNotify callback.

AccountSettlement

11111111119

N(11)

NO

Account for payment settlement

Note

 

String

NO

Text associated with the purchase.

CartItems

2

Int

YES

The number of rows (items) in the logical record Cart.

If there will be some additional fees/taxes for the cardholder, they need to be added as new items.

Cart

Logical Holder

Logical Record

YES

Array provided by the Merchant. The array describes the content of the shopping cart. The content will be displayed on the myPOS Checkout payment page.

OutputFormat

XML

String

NO

Output format of data. The property can be “XML” or “JSON”. If it is not specified in the request, the default value is “XML”.

 

Cart Logical Record

Cart logical record consists of standard POST parameters with the form name=value. For each consequent item, an index is added that shows the logical record number for the item (ex. Atricle_1). Indexes are from 1 to <CartItems>.

Property

Typical value

Type

Description

Article

HP ProBook 6360b sticker

String

Name of an article in the shopping cart.

Quantity

2

Int

How many pieces of an article.

Price

2.34

Double

Price of a single unit.

Amount

4.68

Double

Quantity*Price for the article.

Currency

EUR

A(3)

It should be the same currency as in the purchase amount.

Response properties

Property

Typical value

Type

Description

SessionToken

eyJpbmZvIjoiM............JVNjdnLS0ifQ

String (<255 Symbols)

Session token used for other IPC Calls
Created

2023-06-15T07:07:14Z

DateTime

 Creation date of the token
ExpDate

2023-06-15T08:07:15Z

DateTime

Expire date of the session

 

Example of the response

{
"Status": 0,
"StatusMsg": "Success",
"Created": "2023-06-15T10:04:17Z",
"ExpDate": "2023-06-15T11:04:18Z",
"SessionToken": "eyJpbmZvIjoiMzQ2Mzk0LVZNSklVQ0JYTC0xLTEtRVVSLTUwLWJnIiwiaWRlbnRpdHkiOiJJcENSN1VmfmVic1BqeFg4SG9FUUZYTGU4MVdQTlYybmRUMlVONnppbUVVVnVzZ0tNRHhhbGRsWGFuRUtsYU1DMGVXbGFRLS0ifQ==",
"Signature": "NgSPrI16qrt91HU733Z2KtwW62MtsUptWVLtVF1OGLvG7LKl441aUwqD6fXYmIF/sR6/mbJiFVA2o/v0Izusqb+vHRvmqBdC1+p8n5Zt3mR6BwQZxj1PFWJ0abTUgy4AhJqbkRo47feXCoMxeT8r3n83pkD+MBoM6IaQjZlGRL4="
}
<?xml version="1.0" encoding="UTF-8"?>
<ipc_response is-array="true">
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
<Created>2023-06-15T07:07:14Z</Created>
<ExpDate>2023-06-15T08:07:15Z</ExpDate>
<SessionToken>eyJpbmZvIjoiMzQ2Mzk0LVZNSklVQ0JYTC0xLTEtRVVSLTUwLWJnIiwiaWRlbnRpdHkiOiJ0cVMyR3gzUmY1TnNEbjAxVFJRTlNwUmNwSmJKNEpMU01oYThtWlh3aFlVWEhYamszVkdjdFIzb21mb3dXTllZOFJVNjdnLS0ifQ</SessionToken>
<Signature>QCwWG6KQX53mkelgakPuIUqYGColcjprAaMGb+GjPNcJpnbGfitaef0GBhOa7Qb5wC659yKZaGcZvBuwqXi5TdbB6Mr5M+XXhp8BouPpMVoiuSpJSmQuq9pT/pmf7OeTfJ1fguLcShUdYS1ed1aLrk5O5Dmfj7535JI75ZAvezc=</Signature>
</ipc_response>