Update a settlement account - Equals Documentation

PATCH

roqqett

settlement-accounts

{settlementAccountId}

cURL

curl --request PATCH \
  --url 'https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bankId": "1ffe704d39629a929c8e293880fb449a"
}
'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}"

payload = { "bankId": "1ffe704d39629a929c8e293880fb449a" }
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({bankId: '1ffe704d39629a929c8e293880fb449a'})
};

fetch('https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}', 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/settlement-accounts/{settlementAccountId}",
  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([
    'bankId' => '1ffe704d39629a929c8e293880fb449a'
  ]),
  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/settlement-accounts/{settlementAccountId}"

	payload := strings.NewReader("{\n  \"bankId\": \"1ffe704d39629a929c8e293880fb449a\"\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/settlement-accounts/{settlementAccountId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bankId\": \"1ffe704d39629a929c8e293880fb449a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}")

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  \"bankId\": \"1ffe704d39629a929c8e293880fb449a\"\n}"

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

{
  "id": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
  "name": "Main account",
  "currencyCode": "GBP",
  "bankDetails": {
    "type": "SORT_CODE",
    "sortCode": "040004",
    "accountNumberLastFour": "5678"
  },
  "bankId": "1ffe704d39629a929c8e293880fb449a",
  "bankName": "Example Bank",
  "approvalStatus": "APPROVED",
  "isDefault": true,
  "checkoutIds": [
    "6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"
  ],
  "bankConnection": {
    "status": "CONNECTED",
    "expiresAt": "2027-01-02T12:00:00Z"
  },
  "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

settlementAccountId

string<uuid>

required

The ID of a settlement account: one of the merchant's own bank accounts that SHOPPING checkouts pay into.

Maximum string length: 36

Example:

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

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

bankId

string | null

required

The bank that holds the account, which refunds are paid from. null clears it.

Required string length: 1 - 50

Example:

"1ffe704d39629a929c8e293880fb449a"

Response

string<uuid>

required

The ID of a settlement account: one of the merchant's own bank accounts that SHOPPING checkouts pay into.

Maximum string length: 36

Example:

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

name

string | null

required

The merchant's name for the account. null when none was stored.

Required string length: 1 - 18

Example:

"Main account"

currencyCode

enum<string>

required

ISO-4217 code of a currency Roqqett can take payments in: GBP over Faster Payments, EUR over SEPA Instant.

Available options:

GBP,

EUR

Example:

"GBP"

bankDetails

object

required

Option 1
Option 2

Show child attributes

bankId

string | null

required

The bank that holds the account, which refunds are paid from. null until set; refunds from this account fail until it is.

Required string length: 1 - 50

Example:

"1ffe704d39629a929c8e293880fb449a"

bankName

string | null

required

Name of the bank that holds the account.

Maximum string length: 140

Example:

"Example Bank"

approvalStatus

enum<string>

required

Only an APPROVED account can receive funds or be set on a checkout. A new account is APPROVED automatically only when Equals has given the merchant the top-up permission (canCreateTopUpCheckouts) or the account is an Equals account; otherwise it stays PENDING until Equals approves or rejects it. Merchants cannot set it.

Available options:

PENDING,

APPROVED,

REJECTED

Example:

"APPROVED"

isDefault

boolean

required

Whether SHOPPING checkouts with no settlement account of their own pay into this one. The merchant's first account becomes the default.

checkoutIds

string<uuid>[]

required

Checkouts that pay into this account. An account cannot be deleted while any do.

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

Maximum string length: 36

bankConnection

object

required

The open banking connection that lets Roqqett read this account's transactions for reconciliation.

Show child attributes

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/settlement-accounts/{settlementAccountId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bankId": "1ffe704d39629a929c8e293880fb449a"
}
'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}"

payload = { "bankId": "1ffe704d39629a929c8e293880fb449a" }
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({bankId: '1ffe704d39629a929c8e293880fb449a'})
};

fetch('https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}', 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/settlement-accounts/{settlementAccountId}",
  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([
    'bankId' => '1ffe704d39629a929c8e293880fb449a'
  ]),
  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/settlement-accounts/{settlementAccountId}"

	payload := strings.NewReader("{\n  \"bankId\": \"1ffe704d39629a929c8e293880fb449a\"\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/settlement-accounts/{settlementAccountId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bankId\": \"1ffe704d39629a929c8e293880fb449a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/settlement-accounts/{settlementAccountId}")

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  \"bankId\": \"1ffe704d39629a929c8e293880fb449a\"\n}"

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

{
  "id": "5c8e2a1f-9d4b-4f7a-8e3c-1b6d0f2a9e64",
  "name": "Main account",
  "currencyCode": "GBP",
  "bankDetails": {
    "type": "SORT_CODE",
    "sortCode": "040004",
    "accountNumberLastFour": "5678"
  },
  "bankId": "1ffe704d39629a929c8e293880fb449a",
  "bankName": "Example Bank",
  "approvalStatus": "APPROVED",
  "isDefault": true,
  "checkoutIds": [
    "6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"
  ],
  "bankConnection": {
    "status": "CONNECTED",
    "expiresAt": "2027-01-02T12:00:00Z"
  },
  "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"
    }
  ]
}