Create a client session (API Explorer) | Primer

POSThttps://api.sandbox.primer.io/client-session

Body Parameters

orderIdstring>=1 character<=256 characters
currencyCodeenum
amountlong
orderobject
- lineItemslist of objects(1 item)
  1
  amountlongRequired
  itemIdstring>=1 character<=256 characters
  descriptionstring<=256 characters
  quantityintegerDefaults to 1
- countryCodeenum
customerIdstring>=1 character<=256 characters
customerobject
- emailAddressstringformat: "email"
metadatamap from strings to any
- key
  value
  Shoes
paymentMethodobject
- vaultOnSuccessbooleanDefaults to false
- vaultOn3DSbooleanDefaults to false
- descriptorstring<=256 characters
- optionsobject
  PAYMENT_CARDobject
  networksobject
  VISAobject
  surchargeobject
  amountlong
- authorizationTypeenum

Request

$ curl -X POST https://api.sandbox.primer.io/client-session \
>      -H "X-API-KEY: " \
>      -H "Content-Type: application/json" \
>      -d '{
>   "orderId": "order-abc",
>   "currencyCode": "GBP",
>   "amount": 1000,
>   "order": {
>     "lineItems": [
>       {
>         "amount": 100,
>         "itemId": "shoe-123",
>         "description": "Blue Shoe",
>         "quantity": 10
>       }
>     ],
>     "countryCode": "AW"
>   },
>   "customerId": "customer-123",
>   "customer": {
>     "emailAddress": "john@primer.io"
>   },
>   "metadata": {
>     "productType": "Shoes"
>   },
>   "paymentMethod": {
>     "vaultOnSuccess": true,
>     "vaultOn3DS": false,
>     "descriptor": "Purchase: Shoes",
>     "options": {
>       "PAYMENT_CARD": {
>         "networks": {
>           "VISA": {
>             "surcharge": {
>               "amount": 10
>             }
>           }
>         }
>       }
>     },
>     "authorizationType": "ESTIMATED"
>   }
> }'

Response

$	curl -X POST https://api.sandbox.primer.io/client-session \
>	-H "X-API-KEY: " \
>	-H "Content-Type: application/json" \
>	-d '{
>	"orderId": "order-abc",
>	"currencyCode": "GBP",
>	"amount": 1000,
>	"order": {
>	"lineItems": [
>	{
>	"amount": 100,
>	"itemId": "shoe-123",
>	"description": "Blue Shoe",
>	"quantity": 10
>	}
>	],
>	"countryCode": "AW"
>	},
>	"customerId": "customer-123",
>	"customer": {
>	"emailAddress": "john@primer.io"
>	},
>	"metadata": {
>	"productType": "Shoes"
>	},
>	"paymentMethod": {
>	"vaultOnSuccess": true,
>	"vaultOn3DS": false,
>	"descriptor": "Purchase: Shoes",
>	"options": {
>	"PAYMENT_CARD": {
>	"networks": {
>	"VISA": {
>	"surcharge": {
>	"amount": 10
>	}
>	}
>	}
>	}
>	},
>	"authorizationType": "ESTIMATED"
>	}
>	}'