Online Payments – ClientInfo

The clientInfo resource contains information about the client used for a specific payment.

GET Request

1
2
3
4

GET /psp/paymentorders/09ccd29a-7c4f-4752-9396-12100cbfecce/clientInfo HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json;version=3.x/2.0

GET Response Excerpt

Response clientInfo Excerpt

1
2
3

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8; version=3.x
api-supported-versions: 3.x/2.0

1
2
3
4
5
6
7
8
9
10
11
12
13

{

    "clientInfo": {
        "clientType": "NATIVE",
        "platformName": "SALESFORCE",
        "presentationSdkName": "IOS",
        "presentationSdkVersion": "5.0.0",
        "integrationModuleName": "WOOCOMMERCE",
        "integrationModuleVersion": "1.0.0",
        "integrationSdkName": "DOTNET",
        "integrationSdkVersion": "3.0.0"
        }
      }

clientInfo object

The clientInfo object.

clientType string

Can be WEB or NATIVE. Identifies the client type used to process the payment. This value is set by the app SDK code or the javascript UI code.

platformName string

Identifies the commercial platform used to process the payment. This value is set by the merchant. Examples can be ORACLE, OPTIMIZELY, SALESFORCE etc.

presentationSdkName string

Can be IOS, WEB or ANDROID. Identifies the kind of SDK used to process the payment. This value is set by the frontend SDK.

presentationSdkVersion string

Identifies which version of the SDK that is used to process the payment. This value is set by the frontend SDK.

integrationModuleName string

Can be WOOCOMMERCE. Identifies the kind of module used to process the payment. This value is set by the module.

integrationModuleVersion string

Identifies which version of the module that is used to process the payment. This value is set by the frontend.

integrationSdkName string

Can be DOTNET or PHP. Identifies which kind of SDK that is used to process the payment. This value is set by the integration SDK.

integrationSdkVersion string

Identifies which version of the SDK that is used to process the payment. This value is set by the integration SDK.