Top up a budget by bank transfer - Equals Documentation

POST

roqqett

top-ups

cURL

curl --request POST \
  --url 'https://api.equalsmoney.com/v2/roqqett/top-ups?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "idempotencyKey": "3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47",
  "returnUrl": "https://app.equalsmoney.com/top-up/complete",
  "locale": "en-GB"
}
'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/top-ups"

payload = {
    "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
    "amount": {
        "amount": "10000.00",
        "currencyCode": "GBP"
    },
    "idempotencyKey": "3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47",
    "returnUrl": "https://app.equalsmoney.com/top-up/complete",
    "locale": "en-GB"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    budgetId: '775596ae-2624-40af-a9dc-9756110a4a03',
    amount: {amount: '10000.00', currencyCode: 'GBP'},
    idempotencyKey: '3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47',
    returnUrl: 'https://app.equalsmoney.com/top-up/complete',
    locale: 'en-GB'
  })
};

fetch('https://api.equalsmoney.com/v2/roqqett/top-ups', 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/top-ups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'budgetId' => '775596ae-2624-40af-a9dc-9756110a4a03',
    'amount' => [
        'amount' => '10000.00',
        'currencyCode' => 'GBP'
    ],
    'idempotencyKey' => '3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47',
    'returnUrl' => 'https://app.equalsmoney.com/top-up/complete',
    'locale' => 'en-GB'
  ]),
  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/top-ups"

	payload := strings.NewReader("{\n  \"budgetId\": \"775596ae-2624-40af-a9dc-9756110a4a03\",\n  \"amount\": {\n    \"amount\": \"10000.00\",\n    \"currencyCode\": \"GBP\"\n  },\n  \"idempotencyKey\": \"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47\",\n  \"returnUrl\": \"https://app.equalsmoney.com/top-up/complete\",\n  \"locale\": \"en-GB\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.equalsmoney.com/v2/roqqett/top-ups")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"budgetId\": \"775596ae-2624-40af-a9dc-9756110a4a03\",\n  \"amount\": {\n    \"amount\": \"10000.00\",\n    \"currencyCode\": \"GBP\"\n  },\n  \"idempotencyKey\": \"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47\",\n  \"returnUrl\": \"https://app.equalsmoney.com/top-up/complete\",\n  \"locale\": \"en-GB\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/top-ups")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"budgetId\": \"775596ae-2624-40af-a9dc-9756110a4a03\",\n  \"amount\": {\n    \"amount\": \"10000.00\",\n    \"currencyCode\": \"GBP\"\n  },\n  \"idempotencyKey\": \"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47\",\n  \"returnUrl\": \"https://app.equalsmoney.com/top-up/complete\",\n  \"locale\": \"en-GB\"\n}"

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

{
  "id": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "status": "OPEN",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "locale": "en-GB",
  "checkoutUrl": "https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "expiresAt": "2026-10-02T13:00:00Z",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "id": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "status": "OPEN",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "locale": "en-GB",
  "checkoutUrl": "https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "expiresAt": "2026-10-02T13:00:00Z",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "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

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

budgetId

string<uuid>

required

The budget to top up. It must be on the account and visible to the caller.

Maximum string length: 36

Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

amount

object

required

How much to top up. Must be in a currency the budget holds.

Show child attributes

idempotencyKey

string

required

Caller-supplied key that makes creation safe to retry: a repeat with the same key on the same account returns the original checkout session instead of creating a second one. Use one key per payment journey.

Required string length: 1 - 255

Example:

"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47"

returnUrl

string<uri>

Where the payer is sent once the top-up ends.

Maximum string length: 2048

Example:

"https://app.equalsmoney.com/top-up/complete"

locale

string

BCP 47 language tag for the payer-facing checkout. Matches the locale set held against a person and account in CIS, so a value forwarded from Equals Money always validates. A locale Roqqett has no translations for yet renders in en-GB.

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

Example:

"en-GB"

Response

string<uuid>

required

The ID of a checkout session: one payment journey.

Maximum string length: 36

Example:

"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"

status

enum<string>

required

OPEN until the payer authorises at their bank, PROCESSING while the payment settles, then exactly one terminal status.

Available options:

OPEN,

PROCESSING,

COMPLETED,

CANCELLED,

ABANDONED,

EXPIRED

Example:

"OPEN"

amount

object

required

The total the payer pays, including any shipping.

Show child attributes

locale

string | null

required

The locale the checkout is presented in. null when neither the request nor the checkout set one, in which case the payer's browser preference decides and en-GB is the final fallback.

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

Example:

"en-GB"

checkoutUrl

string<uri>

required

Where to send the payer to pay. Valid until expiresAt.

Maximum string length: 2048

Example:

"https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"

returnUrl

string<uri> | null

required

Where the payer is sent once the session ends.

Maximum string length: 2048

Example:

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

paymentId

string<uuid> | null

required

The payment, once the payer has authorised one.

Maximum string length: 36

Example:

"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"

expiresAt

string<date-time>

required

When an OPEN session expires.

Example:

"2026-10-02T13:00:00Z"

budgetId

string<uuid>

required

The budget being topped up.

Maximum string length: 36

Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

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 POST \
  --url 'https://api.equalsmoney.com/v2/roqqett/top-ups?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "idempotencyKey": "3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47",
  "returnUrl": "https://app.equalsmoney.com/top-up/complete",
  "locale": "en-GB"
}
'

import requests

url = "https://api.equalsmoney.com/v2/roqqett/top-ups"

payload = {
    "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
    "amount": {
        "amount": "10000.00",
        "currencyCode": "GBP"
    },
    "idempotencyKey": "3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47",
    "returnUrl": "https://app.equalsmoney.com/top-up/complete",
    "locale": "en-GB"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    budgetId: '775596ae-2624-40af-a9dc-9756110a4a03',
    amount: {amount: '10000.00', currencyCode: 'GBP'},
    idempotencyKey: '3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47',
    returnUrl: 'https://app.equalsmoney.com/top-up/complete',
    locale: 'en-GB'
  })
};

fetch('https://api.equalsmoney.com/v2/roqqett/top-ups', 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/top-ups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'budgetId' => '775596ae-2624-40af-a9dc-9756110a4a03',
    'amount' => [
        'amount' => '10000.00',
        'currencyCode' => 'GBP'
    ],
    'idempotencyKey' => '3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47',
    'returnUrl' => 'https://app.equalsmoney.com/top-up/complete',
    'locale' => 'en-GB'
  ]),
  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/top-ups"

	payload := strings.NewReader("{\n  \"budgetId\": \"775596ae-2624-40af-a9dc-9756110a4a03\",\n  \"amount\": {\n    \"amount\": \"10000.00\",\n    \"currencyCode\": \"GBP\"\n  },\n  \"idempotencyKey\": \"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47\",\n  \"returnUrl\": \"https://app.equalsmoney.com/top-up/complete\",\n  \"locale\": \"en-GB\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.equalsmoney.com/v2/roqqett/top-ups")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"budgetId\": \"775596ae-2624-40af-a9dc-9756110a4a03\",\n  \"amount\": {\n    \"amount\": \"10000.00\",\n    \"currencyCode\": \"GBP\"\n  },\n  \"idempotencyKey\": \"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47\",\n  \"returnUrl\": \"https://app.equalsmoney.com/top-up/complete\",\n  \"locale\": \"en-GB\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/top-ups")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"budgetId\": \"775596ae-2624-40af-a9dc-9756110a4a03\",\n  \"amount\": {\n    \"amount\": \"10000.00\",\n    \"currencyCode\": \"GBP\"\n  },\n  \"idempotencyKey\": \"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47\",\n  \"returnUrl\": \"https://app.equalsmoney.com/top-up/complete\",\n  \"locale\": \"en-GB\"\n}"

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

{
  "id": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "status": "OPEN",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "locale": "en-GB",
  "checkoutUrl": "https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "expiresAt": "2026-10-02T13:00:00Z",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "id": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "status": "OPEN",
  "amount": {
    "amount": "10000.00",
    "currencyCode": "GBP"
  },
  "locale": "en-GB",
  "checkoutUrl": "https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
  "returnUrl": "https://shop.example.com/checkout/complete",
  "paymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
  "expiresAt": "2026-10-02T13:00:00Z",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "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"
    }
  ]
}