The Process
Understanding how transactions are transmitted and processed is essential for integrating with the Checkout API. Below, you'll find a user-friendly overview of the process, including the standard properties required in every request and response.
Understanding Transmission Mechanism
The Checkout API uses a secure, structured mechanism to transmit transaction data. Each request and response follows a defined scheme to ensure reliability and security.
Transaction Process Scheme
- Client prepares a request with all required parameters (see below for standard properties).
- Request is sent to the Checkout API endpoint.
- API processes the request, validates the signature, and executes the requested method.
- Response is returned to the client, containing standard response properties.
Method Standard Properties
Every request to the Checkout API must include several standard properties. These are always present and are not repeated in every command description. Treat them as required for all commands.
| Property | Typical value | Type | Description |
|---|---|---|---|
| IPCmethod | IPCPurchase | String | Name of the method requested for execution from IPC. |
| Signature | Byte[] (BASE64) | String | SHA-256 HASH for all properties in the command. Always the last POST param. |
| 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 transmission. |
| IPCLanguage | EN | A(2) | ISO 2-character code for the payment page language. Defaults to EN. |
| WalletNumber | 61938166610 | N(11) | myPOS Client Number. |
| SID | 000000000000010 | AN(15) | Site ID. Identifier of the website accepting payment. |
Supported Languages: EN, FR, IT, DE, SV, PT, NL, EL, BG, ES. If the requested language is not available, English (EN) will be used by default.
Response Standard Properties
After sending an HTTP request, the API will respond with an HTTP 200 OK status and the following body content: OK. Any other response indicates a communication, call, server, or system error.
Every response includes these standard properties:
| 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 the status code. |
| Signature | Byte[] (BASE64) | String | SHA-256 HASH for all properties in the command. Last POST param. |
Once defined, these parameters are considered present in every response described in the specification.