Create Transaction

You can use this call to create a new Checkout transaction.

Prerequisite

Get an access_token and use it as 'Bearer' token in your request. Find more details here.

Request

POST https://api.pay.cm.com/api/v1/paymentmethods/checkout/v1/transactions

Request body examples

These are only some examples of the request body to create a transaction:

{
  "reference": "20210623130413",
  "amount": 1200,
  "currency": "EUR",
  "consumer": {
    "givenName": "John",
    "middleName": "",
    "familyName": "Doe",
    "email": "[email protected]",
    "gender": null,
    "address": {
      "street": "Rustenburgerlaan",
      "houseNumber": "25",
      "postalCode": "2012AL",
      "city": "Haarlem",
      "countryCode": "NL",
      "state": "Noord-Holland",
      "additionalData": "Right-hand portal"
    },
    "phone": "06-95613259",
    "dateOfBirth": "1996-12-01"
  },
  "merchantOrderReference": "order123",
  "description": "Order at yourdomain.tld",
  "paymentMethods": [
    "ideal",
    "bancontact",
    "klarna"
  ],
  "orderItems": [
    {
      "code": "SDC4/32GB-2ADP",
      "name": "Kingston microSD 32GB",
      "description": "Best seller SD card",
      "unitPrice": 600,
      "quantity": 2,
      "vatAmount": 100,
      "vatRate": 20
    }
  ],
  "expiresAt": "2006-01-02T15:04:05Z",
  "language": "nl",
  "webhooks": [
    {
      "url": "https://yourdomain.tld/order-webhooks?purchaseId=order123",
      "events": [
        "FINALSTATUS"
      ]
    },
    {
      "url": "https://yourdomain.tld/payment-webhooks?purchaseId=order123",
      "events": [
        "REFUND_STATUS"
      ]
    },
    {
      "url": "https://yourdomain.tld/payment-webhooks?purchaseId=order123",
      "events": [
        "STATUS_CHANGE"
      ]
    }
  ],
  "maxRetries": 10,
  "returnUrls": {
    "success": "https://yourdomain.tld/order/payment-success.html",
    "cancelled": "https://yourdomain.tld/order/payment-cancelled.html",
    "expired": "https://yourdomain.tld/order/payment-expired.html",
    "failed": "https://yourdomain.tld/order/payment-failed.html"
  }
}

{
  "reference": "20210623130413",
  "amount": 1200,
  "currency": "EUR",
  "consumer": {
    "givenName": "John",
    "middleName": "",
    "familyName": "Doe",
    "email": "[email protected]",
    "gender": null,
    "address": {
      "street": "Rustenburgerlaan",
      "houseNumber": "25",
      "postalCode": "2012AL",
      "city": "Haarlem",
      "countryCode": "NL",
      "state": "Noord-Holland",
      "additionalData": "Right-hand portal"
    },
    "phone": "06-95613259",
    "dateOfBirth": "1996-12-01"
  },
  "merchantOrderReference": "order123",
  "description": "Order at yourdomain.tld",
  "paymentMethods": [
    "ideal",
    "bancontact",
    "klarna"
  ],
  "orderItems": [
    {
      "code": "SDC4/32GB-2ADP",
      "name": "Kingston microSD 32GB",
      "description": "Best seller SD card",
      "unitPrice": 600,
      "quantity": 2,
      "vatAmount": 100,
      "vatRate": 20
    }
  ],
  "expiresAt": "2006-01-02T15:04:05Z",
  "language": "nl",
  "webhooks": [
    {
      "url": "https://yourdomain.tld/order-webhooks?purchaseId=order123",
      "events": [
        "FINALSTATUS"
      ]
    },
    {
      "url": "https://yourdomain.tld/payment-webhooks?purchaseId=order123",
      "events": [
        "REFUND_STATUS"
      ]
    },
    {
      "url": "https://yourdomain.tld/payment-webhooks?purchaseId=order123",
      "events": [
        "STATUS_CHANGE"
      ]
    }
  ],
  "maxRetries": 10,
  "returnUrl": "https://yourdomain.tld/order/payment-completed.html"
}

{
  "reference": "20210623130413",
  "amount": 1200,
  "merchantOrderReference": "order123",
  "description": "Order at yourdomain.tld",
  "expiresAt": "2006-01-02T15:04:05Z",
  "language": "nl",
  "returnUrls": {
    "success": "https://yourdomain.tld/order/payment-success.html",
    "cancelled": "https://yourdomain.tld/order/payment-cancelled.html",
    "expired": "https://yourdomain.tld/order/payment-expired.html",
    "failed": "https://yourdomain.tld/order/payment-failed.html"
  }
}

"Full Request with ReturnURLs" and "Full Request with ReturnURL" are examples where all the request parameters are provided. If returnUrls is defined then customers will be redirected to a different URL depending on the status of the transaction when the payment process is completed. If returnUrl is defined then customers will be redirected to the same URL no matter the status of the transaction when the payment process is completed.

"Minimal Request with ReturnURLs" is an example of the minimal request to create a transaction. This example, is using returnUrls, but you can replace it for returnUrl depending on what is better for your use case.

Parameters

Parameter	Type	Description	Constraints
reference	String(1...255)	An identifier specified by you. If webhooks were specified in the request this identifier is added to the webhook request payload.
amount	Int(1...99999999)	Integer representing the amount of the checkout. Denomination in the smallest currency subunit (e.g. eurocents). If `orderItems` is provided, then a calculated amount, based on the sum of the product of item.UnitPrice and item.Quantity for all the items, will be used as checkout amount instead of the value provided in this field.	For payment methods like in3, this value should be `>= 5000 cents`. If in3 is enabled on your configuration, the amount (or calculated amount based on the orderItems) is `<5000 cents`, and you did not specify in3 in the `paymentMethods` request parameter, then you will NOT see in3 in the `paymentMethods` response parameter (so it will not be included in the checkout payment method selection page). If in3 is enabled on your configuration, the amount (or calculated amount based on the orderItems) is `<5000 cents`, but if you specify in3 in the `paymentMethods` request parameter, then you will get a validation error while creating the checkout transaction.
merchantOrderReference	String(1...35)	Identification of the order within your system. Ultimately appears on the payment confirmation (statement and confirmation screen).
description	String(1...255)	Description of the transaction.
expiresAt	String(RFC3339)	Specifies the time at which new payments cannot be started in the Checkout. At the time of expiration the Checkout status will transition to `PENDING` if there are still `OPEN` or `PENDING` payments. Once the payments are no longer `OPEN` or `PENDING` the status of the checkout will transaction to `EXPIRED` or in the case of a successful payment to `SUCCESS`.	ISO 8601 date and time.
language	String(ISO 639-1)	Preferred language of the user interface.	The available languages are: `[ cs, da, de, en, es, fi, fr, hu, it, nl, no, pl, pt, sv, tr ]`.
returnUrl	String(2000)	Specifies the URL where your customers will be redirected to when the payment process is completed.	Either `returnUrl` or `returnUrls` must be specified, but not both.
returnUrls	returnUrls Object	Specifies a URL where your customers will be redirected to (per transaction status) when the payment process is completed. For example, your customers will be redirected to `returnUrls.success` when the status of the transaction changes to `SUCCESS`.	Either `returnUrl` or `returnUrls` must be specified, but not both.

Optional parameters

Parameter	Type	Description	Constraints
currency	String (ISO 4217)	Currency code.	ISO 4217 currency code.
consumer	consumerInRequest Object	Customer details.	If `consumer` is provided then the following fields are mandatory: `givenName`, `familyName`, `email`, `phone`. If `consumer.address` is provided then the following fields are mandatory: `street`, `houseNumber`, `postalCode`, `city`, `countryCode`. For in3, the following consumer details are required: `familyName`, `phone`, `email`, `dateOfBirth`, `address.street`, `address.houseNumber`, `address.postalCode`, `address.city`, and `address.countryCode`. If any required information is missing in the request, then the consumer form will be displayed in the checkout to collect the missing details.
paymentMethods	Array of strings	This parameter indicates which payment methods you want the checkout to make available for your customers on the checkout payment methods selection page. Note: some payment methods like Klarna or in3 require stricter validation to be enabled. If you specify `klarna` or `in3` in this parameter, then the validation will be done while creating the transaction. If you do not specify them in this parameter, then given your configuration and the other values you provided in your request, it might cause these payment methods not to be included in the `paymentMethods` response parameter (so they will NOT be included on the checkout payment methods selection page).	The available payment methods are: `[ bancontact, creditcard, ideal, maestro, belfius, giropay, klarna, blik, przelewy24, elv, google_pay, apple_pay, in3 ]`. The selected payment methods must be enabled in your configuration.
webhooks	Array of objects	Webhooks enable receiving a web request once a given event occurs.	Find more details here.
maxRetries	Int(0...255)	Maximum number of retries allowed to pay the checkout.
orderItems	Array of orderItem objects	Required only for some payment methods (e.g. Klarna or in3). If (Klarna or in3) is enabled in your configuration, but you did not specify neither `orderItems` on your request nor (Klarna or in3) on the `paymentMethods` request parameter, then you will NOT see (Klarna or in3) on the `paymentMethods` response parameter (so they will not be included in the checkout payment method selection page). If (Klarna or in3) is enabled in your configuration, and you do not specify `orderItems` in your request, but you specify (Klarna or in3) in the `paymentMethods` request parameter, then you will get a validation error while creating the checkout transaction. Apart from that, if `orderItems` is provided, then a calculated amount, based on the sum of the product of item.UnitPrice and item.Quantity for all the items, will be used as checkout amount instead of the value provided as `amount` on the request.

Response

{
  "id": "8db1e7fa-ba8a-4189-92fd-67a20217443d",
  "reference": "20210623130413",
  "amount": 1200,
  "currency": "EUR",
  "consumer": {
    "givenName": "John",
    "middleName": "",
    "familyName": "Doe",
    "email": "[email protected]",
    "gender": null,
    "address": {
      "street": "Rustenburgerlaan",
      "houseNumber": "25",
      "postalCode": "2012AL",
      "city": "Haarlem",
      "countryCode": "NL",
      "state": "Noord-Holland",
      "additionalData": "Right-hand portal"
    },
    "phone": "06-95613259",
    "dateOfBirth": "1996-12-01"
  },
  "merchantOrderReference": "order123",
  "description": "Order at yourdomain.tld",
  "paymentMethods": [
    "ideal",
    "bancontact",
    "klarna"
  ],
  "orderItems": [
    {
      "code": "SDC4/32GB-2ADP",
      "name": "Kingston microSD 32GB",
      "description": "Best seller SD card",
      "unitPrice": 600,
      "quantity": 2,
      "vatAmount": 100,
      "vatRate": 20
    }
  ],
  "expiresAt": "2006-01-02T15:04:05Z",
  "language": "nl",
  "webhooks": [
    {
      "url": "https://yourdomain.tld/order-webhooks?purchaseId=order123",
      "events": [
        "FINALSTATUS"
      ]
    },
    {
      "url": "https://yourdomain.tld/payment-webhooks?purchaseId=order123",
      "events": [
        "REFUND_STATUS"
      ]
    },
    {
      "url": "https://yourdomain.tld/payment-webhooks?purchaseId=order123",
      "events": [
        "STATUS_CHANGE"
      ]
    }
  ],
  "maxRetries": 10,
  "status": "OPEN",
  "action": {
    "redirect": {
      "url": "https://checkout.cmpayments.com/?hostedCheckoutId=0863a7aadb99bf1c6ae770936db45eb33e61c917"
    }
  },
  "createdAt": "2006-01-02T15:04:05Z",
  "refunds": {
    "refundedAmount": 300,
    "refundedPendingAmount": 100
  },
  "returnUrls": {
    "success": "https://yourdomain.tld/order/payment-success.html",
    "cancelled": "https://yourdomain.tld/order/payment-cancelled.html",
    "expired": "https://yourdomain.tld/order/payment-expired.html",
    "failed": "https://yourdomain.tld/order/payment-failed.html"
  }
}

Parameters

Parameter	Type	Description	Constraints
id	String(36)	Transaction unique identifier.
reference	String(1...255)	An identifier specified by you. If webhooks were specified in the request this identifier is added to the webhook request payload.	Specified in the request.
amount	Int(1...99999999)	Integer representing the amount of the checkout. Denomination in the smallest currency subunit (e.g. eurocents).	Specified in the request.
currency	String (ISO 4217)	Currency code.	Specified in the request.
merchantOrderReference	String(1...35)	Identification of the order within your system. Ultimately appears on the payment confirmation (statement and confirmation screen).	Specified in the request.
description	String(1...255)	Description of the transaction.	Specified in the request.
expiresAt	String(RFC3339)	Specifies the time at which new payments cannot be started in the Checkout. At the time of expiration the Checkout status will transition to `PENDING` if there are still `OPEN` or `PENDING` payments. Once the payments are no longer `OPEN` or `PENDING` the status of the checkout will transaction to `EXPIRED` or in the case of a successful payment to `SUCCESS`.	Specified in the request.
status	String	`OPEN` - Checkout has been created. This is the initial status. `SUCCESS` - Checkout successfully paid. `CANCELLED` - Checkout has been cancelled by your customers. `EXPIRED` - Checkout has not succeeded; expired. `FAILURE` - Checkout has not succeeded; unknown reason. `AUTHORIZED` - Checkout payment is authorized. `PENDING` - Checkout payment could not be completed yet; waiting for something.
action	action Object	The next action to be performed by you for this transaction. This includes a URL where you should `redirect` your customer to perform the payment.	This parameter is nullable, and it is only available while the transaction is `OPEN`.
createdAt	String(RFC3339)	Creation time.	ISO 8601 date and time.
returnUrl	String(2000)	Specifies the URL where your customers will be redirected to when the payment process is completed.	Specified in the request.
returnUrls	Object	Specifies a URL where your customers will be redirected to (per transaction status) when the payment process is completed. For example, your customers will be redirected to `returnUrls.success` when the status of the transaction changes to `SUCCESS`.	Specified in the request.

Optional parameters

Parameter	Type	Description	Constraints
consumer	Object	Customer details.	Specified in the request or by the configuration of your account.
paymentMethods	Array of strings	This is an important field because here you can validate which payment methods will be available for your customers on the checkout payment method selection page.	Even if you provided specific values as `paymentMethods` in your request, the value in the response might not be the same, given that it also depends on your configuration and on other values you provided in your request. For this reason, it is recommended that you always check this value in the response.
orderItems	Array of objects	Required only for some payment methods (e.g. Klarna or in3).	Specified in the request.
language	String(ISO 639-1)	Preferred language of the user interface.	Specified in the request.
webhooks	Array of objects	Webhooks enable receiving a web request once a given event occurs.	Specified in the request.
maxRetries	Int(0...255)	Maximum number of retries allowed to pay the checkout.	Specified in the request.
refunds	refund Object	Indicates refundedAmount and refundedPendingAmount.

Response codes

HTTP status	Description
201	Successful transaction.
4XX	Client error response (See message for details). This response is given when the user input was incorrect or something illegal was attempted (eg. using a service without having that service configured for the user, or not being authorized).
5XX	Server error response (See message for details).