Understanding Transmission Mechanism

 

 


Method Standard Properties

 

In every request, there are several parameters that are always supplied. Bellow, they are called ‘standard properties’. Once defined below, they won’t be described in every single command listed in the specification, they should be considered as existing to every command.

 

Property

Typical value

Type

Description

IPCmethod

IPCPurchase

String

Name of the method requested for execution from IPC.

Signature

Byte[]

BASE64

SHA-256 HASH for all properties in the command. Signature is ALWAYS THE LAST PARAMETER IN THE POST, as it is not used to calculate the hash.

KeyIndex

1

Int

Identifier of the private key used for signature (if more than 1).

IPCVersion

1.3

string

The version of the protocol used for transition.

IPCLanguage

EN

A(2)

ISO 2-character code for the desired language on the payment page. If myPOS Checkout API cannot fulfill the requested language, it will set the English language as defaults.

Currently supporting EN, FR, IT, DE, SV, PT, NL, EL,  BG, ES.

WalletNumber

61938166610

N(11)

myPOS Client Number

SID

000000000000010

AN(15)

Site ID. Identifier of the website accepting payment.

 


Response Standard Properties

 

Upon HTTP request, the party should respond with header HTTP 200 OK with the following body content: “OK”. Every other response will be treated as a communication error, call error, server error or system malfunctions.

 

Property

Typical value

Type

Description

IPCmethod

IPCPurchase

String

Name of the method requested for execution from IPC.

Status

0

N(3)

Code upon command completion. 0 is success otherwise error.

StatusMsg

Success

C(max)

Description for <status> code.

Signature

Byte[]

BASE64

SHA-256 HASH for all properties in the command. Signature is ALWAYS THE LAST PARAMETER IN THE POST, as it is not used to calculate the hash.

 

Once defined these parameters should be considered as existing to every response listed in the specification.