Update a checkout - Equals Documentation

PATCH

roqqett

checkouts

{checkoutId}

cURL

curl --request PATCH \
  --url 'https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Online shop",
  "status": "ACTIVE",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "locale": "en-GB",
  "settlementAccountId": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
  "shippingOptions": {
    "collectAddress": true,
    "dynamicRatesUrl": "https://shop.example.com/shipping/rates"
  }
}
'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}"

payload = {
    "name": "Online shop",
    "status": "ACTIVE",
    "returnUrl": "https://shop.example.com/checkout/complete",
    "locale": "en-GB",
    "settlementAccountId": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
    "shippingOptions": {
        "collectAddress": True,
        "dynamicRatesUrl": "https://shop.example.com/shipping/rates"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Online shop',
    status: 'ACTIVE',
    returnUrl: 'https://shop.example.com/checkout/complete',
    locale: 'en-GB',
    settlementAccountId: '5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64',
    shippingOptions: {
      collectAddress: true,
      dynamicRatesUrl: 'https://shop.example.com/shipping/rates'
    }
  })
};

fetch('https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Online shop',
    'status' => 'ACTIVE',
    'returnUrl' => 'https://shop.example.com/checkout/complete',
    'locale' => 'en-GB',
    'settlementAccountId' => '5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64',
    'shippingOptions' => [
        'collectAddress' => true,
        'dynamicRatesUrl' => 'https://shop.example.com/shipping/rates'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}"

	payload := strings.NewReader("{\n  \"name\": \"Online shop\",\n  \"status\": \"ACTIVE\",\n  \"returnUrl\": \"https://shop.example.com/checkout/complete\",\n  \"locale\": \"en-GB\",\n  \"settlementAccountId\": \"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64\",\n  \"shippingOptions\": {\n    \"collectAddress\": true,\n    \"dynamicRatesUrl\": \"https://shop.example.com/shipping/rates\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Online shop\",\n  \"status\": \"ACTIVE\",\n  \"returnUrl\": \"https://shop.example.com/checkout/complete\",\n  \"locale\": \"en-GB\",\n  \"settlementAccountId\": \"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64\",\n  \"shippingOptions\": {\n    \"collectAddress\": true,\n    \"dynamicRatesUrl\": \"https://shop.example.com/shipping/rates\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Online shop\",\n  \"status\": \"ACTIVE\",\n  \"returnUrl\": \"https://shop.example.com/checkout/complete\",\n  \"locale\": \"en-GB\",\n  \"settlementAccountId\": \"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64\",\n  \"shippingOptions\": {\n    \"collectAddress\": true,\n    \"dynamicRatesUrl\": \"https://shop.example.com/shipping/rates\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12",
  "type": "SHOPPING",
  "name": "Online shop",
  "status": "ACTIVE",
  "currencyCode": "GBP",
  "settlementAccountId": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
  "shippingOptions": {
    "collectAddress": true,
    "dynamicRatesUrl": "https://shop.example.com/shipping/rates"
  },
  "returnUrl": "https://shop.example.com/checkout/complete",
  "locale": "en-GB",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

checkoutId

string<uuid>

required

The ID of a checkout: the configured payment page a checkout session is taken on.

Maximum string length: 36

Example:

"6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

name

string

The merchant's name for the checkout. Never shown to payers.

Required string length: 1 - 64

Example:

"Online shop"

status

enum<string>

Only an ACTIVE checkout can take new checkout sessions; sessions already created can still complete. The merchant switches between them.

Available options:

ACTIVE,

DEACTIVATED

Example:

"ACTIVE"

returnUrl

string<uri>

Where the payer is sent once a checkout session ends, unless the session sets its own.

Maximum string length: 2048

Pattern: ^https:\/\/

Example:

"https://shop.example.com/checkout/complete"

locale

string | null

Default locale for payer-facing screens. null clears it.

Pattern: ^[a-zA-Z]{2,3}(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|\d{3}))?$

Example:

"en-GB"

settlementAccountId

string<uuid> | null

SHOPPING only. The APPROVED settlement account, in the checkout's currency, that sessions pay into. null switches to the default settlement account.

Maximum string length: 36

Example:

"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64"

shippingOptions

object

SHOPPING only. Replaces the shipping options as a whole.

Show child attributes

Response

string<uuid>

required

The ID of a checkout: the configured payment page a checkout session is taken on.

Maximum string length: 36

Example:

"6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"

type

enum<string>

required

The type of checkout session the checkout takes. Fixed at creation.

Available options:

SHOPPING,

TOP_UP

Example:

"SHOPPING"

name

string | null

required

The merchant's name for the checkout. Never shown to payers. null when none was stored.

Minimum string length: 1

Example:

"Online shop"

status

enum<string>

required

Only an ACTIVE checkout can take new checkout sessions; sessions already created can still complete. The merchant switches between them.

Available options:

ACTIVE,

DEACTIVATED

Example:

"ACTIVE"

currencyCode

enum<string>

required

The currency the checkout takes payments in. Fixed at creation.

Available options:

GBP,

EUR

Example:

"GBP"

settlementAccountId

string<uuid> | null

required

The settlement account SHOPPING sessions pay into. null uses the default settlement account; always null for TOP_UP, whose sessions pay into a payee.

Maximum string length: 36

Example:

"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64"

shippingOptions

object | null

required

Shipping collection for SHOPPING checkouts. Always null for TOP_UP.

Show child attributes

returnUrl

string<uri>

required

Where the payer is sent once a checkout session ends, unless the session sets its own.

Maximum string length: 2048

Pattern: ^https:\/\/

Example:

"https://shop.example.com/checkout/complete"

locale

string | null

required

Default locale for payer-facing screens. A session's own locale overrides it. null lets the payer's browser decide, with en-GB as the final fallback.

Pattern: ^[a-zA-Z]{2,3}(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|\d{3}))?$

Example:

"en-GB"

createdAt

string<date-time>

required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAt

string<date-time>

required

The date the Resource was last modified. ISO 8601 format without milliseconds.

⌘I

cURL

curl --request PATCH \
  --url 'https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Online shop",
  "status": "ACTIVE",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "locale": "en-GB",
  "settlementAccountId": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
  "shippingOptions": {
    "collectAddress": true,
    "dynamicRatesUrl": "https://shop.example.com/shipping/rates"
  }
}
'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}"

payload = {
    "name": "Online shop",
    "status": "ACTIVE",
    "returnUrl": "https://shop.example.com/checkout/complete",
    "locale": "en-GB",
    "settlementAccountId": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
    "shippingOptions": {
        "collectAddress": True,
        "dynamicRatesUrl": "https://shop.example.com/shipping/rates"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Online shop',
    status: 'ACTIVE',
    returnUrl: 'https://shop.example.com/checkout/complete',
    locale: 'en-GB',
    settlementAccountId: '5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64',
    shippingOptions: {
      collectAddress: true,
      dynamicRatesUrl: 'https://shop.example.com/shipping/rates'
    }
  })
};

fetch('https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Online shop',
    'status' => 'ACTIVE',
    'returnUrl' => 'https://shop.example.com/checkout/complete',
    'locale' => 'en-GB',
    'settlementAccountId' => '5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64',
    'shippingOptions' => [
        'collectAddress' => true,
        'dynamicRatesUrl' => 'https://shop.example.com/shipping/rates'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}"

	payload := strings.NewReader("{\n  \"name\": \"Online shop\",\n  \"status\": \"ACTIVE\",\n  \"returnUrl\": \"https://shop.example.com/checkout/complete\",\n  \"locale\": \"en-GB\",\n  \"settlementAccountId\": \"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64\",\n  \"shippingOptions\": {\n    \"collectAddress\": true,\n    \"dynamicRatesUrl\": \"https://shop.example.com/shipping/rates\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Online shop\",\n  \"status\": \"ACTIVE\",\n  \"returnUrl\": \"https://shop.example.com/checkout/complete\",\n  \"locale\": \"en-GB\",\n  \"settlementAccountId\": \"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64\",\n  \"shippingOptions\": {\n    \"collectAddress\": true,\n    \"dynamicRatesUrl\": \"https://shop.example.com/shipping/rates\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/checkouts/{checkoutId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Online shop\",\n  \"status\": \"ACTIVE\",\n  \"returnUrl\": \"https://shop.example.com/checkout/complete\",\n  \"locale\": \"en-GB\",\n  \"settlementAccountId\": \"5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64\",\n  \"shippingOptions\": {\n    \"collectAddress\": true,\n    \"dynamicRatesUrl\": \"https://shop.example.com/shipping/rates\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12",
  "type": "SHOPPING",
  "name": "Online shop",
  "status": "ACTIVE",
  "currencyCode": "GBP",
  "settlementAccountId": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
  "shippingOptions": {
    "collectAddress": true,
    "dynamicRatesUrl": "https://shop.example.com/shipping/rates"
  },
  "returnUrl": "https://shop.example.com/checkout/complete",
  "locale": "en-GB",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}