POST
/
v1
/
checkout-sessions
Create Checkout Session
curl --request POST \
  --url https://api.monime.io/v1/checkout-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "cancelUrl": "<string>",
  "successUrl": "<string>",
  "callbackState": "<string>",
  "reference": "<string>",
  "financialAccountId": "<string>",
  "lineItems": [
    {
      "type": "custom",
      "name": "<string>",
      "price": {
        "currency": "<string>",
        "value": 123
      },
      "quantity": 1,
      "reference": "<string>",
      "description": "<string>",
      "images": [
        "<string>"
      ]
    }
  ],
  "paymentOptions": {
    "card": {
      "disable": false
    },
    "bank": {
      "disable": false,
      "enabledProviders": [
        "slb001"
      ],
      "disabledProviders": [
        "slb001"
      ]
    },
    "momo": {
      "disable": false,
      "enabledProviders": [
        "m17"
      ],
      "disabledProviders": [
        "m17"
      ]
    },
    "wallet": {
      "disable": false,
      "enabledProviders": [
        "dw001"
      ],
      "disabledProviders": [
        "dw001"
      ]
    }
  },
  "brandingOptions": {
    "primaryColor": "<string>"
  },
  "metadata": {}
}'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": {
    "id": "<string>",
    "name": "<string>",
    "reference": "<string>",
    "description": "<string>",
    "status": "pending",
    "redirectUrl": "<string>",
    "cancelUrl": "<string>",
    "successUrl": "<string>",
    "lineItems": {
      "data": [
        {
          "type": "custom",
          "id": "<string>",
          "name": "<string>",
          "price": {
            "currency": "<string>",
            "value": 123
          },
          "quantity": 1,
          "reference": "<string>",
          "description": "<string>",
          "images": [
            "<string>"
          ]
        }
      ]
    },
    "financialAccountId": "<string>",
    "brandingOptions": {
      "primaryColor": "<string>"
    },
    "expireTime": "2023-11-07T05:31:56Z",
    "createTime": "2023-11-07T05:31:56Z",
    "ownershipGraph": {
      "owner": {
        "id": "<string>",
        "type": "<string>",
        "metadata": {},
        "owner": {
          "id": "<string>",
          "type": "<string>",
          "metadata": {},
          "owner": {}
        }
      }
    },
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Maximum length: 64
​
Monime-Space-Id
string
required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum length: 64

Body

application/json

Creates a new checkout session to initiate a user payment experience.

Response

200 - application/json

OK

The response is of type object.