Client Session API

Retrieve a client session

GET
This API call retrieves all the details associated with the client session corresponding to the client token that is provided in the request. The fields with empty values are excluded from the response.

Query parameters

clientTokenstringOptional
Client token corresponding to the client session to retrieve

Response

This endpoint returns an object
customerId
stringOptional
A unique identifier for your customer.
orderId
stringOptional
Your reference for the payment.
currencyCode
enumOptional

The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.

amount
integerOptional

The amount you are going to charge the customer, in minor units. This amount is calculated from the line items, shipping and other amounts provided in the order. If a top-level amount is provided, it would override any calculated amount.

metadata
map from strings to anyOptional
Additional data to be used throughout the payment lifecycle.
customer
objectOptional
More information associated with the customer.
order
objectOptional
More information associated with the order.
paymentMethod
objectOptional
Enable certain options associated with the payment methods.

Errors

GET
$curl https://api.sandbox.primer.io/client-session \
>     -H "X-API-KEY: <apiKey>"
Response
1{
2  "currencyCode": "AED",
3  "customer": {
4    "billingAddress": {
5      "countryCode": "AW"
6    },
7    "shippingAddress": {
8      "countryCode": "AW"
9    }
10  },
11  "order": {
12    "lineItems": [
13      {
14        "amount": 1,
15        "productType": "PHYSICAL",
16        "productData": {}
17      }
18    ],
19    "countryCode": "AW",
20    "retailerCountryCode": "AW",
21    "fees": [
22      {
23        "amount": 1
24      }
25    ],
26    "shipping": {}
27  },
28  "paymentMethod": {
29    "paymentType": "FIRST_PAYMENT",
30    "orderedAllowedCardNetworks": [
31      "AMEX"
32    ],
33    "options": {
34      "<PAYMENT_METHOD_TYPE>": {
35        "surcharge": {}
36      },
37      "PAYMENT_CARD": {
38        "networks": {
39          "AMEX": {
40            "surcharge": {}
41          },
42          "CARTES_BANCAIRES": {
43            "surcharge": {}
44          },
45          "DANKORT": {
46            "surcharge": {}
47          },
48          "DINERS_CLUB": {
49            "surcharge": {}
50          },
51          "DISCOVER": {
52            "surcharge": {}
53          },
54          "ENROUTE": {
55            "surcharge": {}
56          },
57          "ELO": {
58            "surcharge": {}
59          },
60          "HIPER": {
61            "surcharge": {}
62          },
63          "INTERAC": {
64            "surcharge": {}
65          },
66          "JCB": {
67            "surcharge": {}
68          },
69          "MAESTRO": {
70            "surcharge": {}
71          },
72          "MASTERCARD": {
73            "surcharge": {}
74          },
75          "MIR": {
76            "surcharge": {}
77          },
78          "PRIVATE_LABEL": {
79            "surcharge": {}
80          },
81          "UNIONPAY": {
82            "surcharge": {}
83          },
84          "VISA": {
85            "surcharge": {}
86          },
87          "OTHER": {
88            "surcharge": {}
89          }
90        }
91      }
92    },
93    "authorizationType": "ESTIMATED"
94  }
95}
Built with