Retrieve the merchant - Equals Documentation

GET

roqqett

merchant

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/merchant?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/roqqett/merchant', 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/merchant",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.equalsmoney.com/v2/roqqett/merchant"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/merchant")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "accountId": "F50091",
  "name": "Example Shop",
  "status": "ACTIVE",
  "logoUrl": "https://pay.roqqett.com/api/assets-management/avatar-image/e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "returnPolicyUrl": "https://shop.example.com/returns",
  "branding": {
    "primaryColour": "#1A2B3C",
    "contentOnPrimaryColour": "#1A2B3C",
    "secondaryColour": "#1A2B3C",
    "contentOnSecondaryColour": "#1A2B3C",
    "hideRoqqettLogo": true
  },
  "brandingPermissions": {
    "canCustomiseColours": true,
    "canHideRoqqettLogo": true
  },
  "canCreateTopUpCheckouts": false,
  "reconciliation": {
    "enabled": true
  },
  "paymentsSummary": [
    {
      "currencyCode": "GBP",
      "today": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      },
      "last7Days": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      },
      "last30Days": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      }
    }
  ],
  "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"

include

enum<string>

Optional properties to populate on the merchant. Without paymentsSummary, paymentsSummary is null. Use commas to pass multiple values.

Available options:

paymentsSummary

Example:

"paymentsSummary"

Response

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

name

string

required

The merchant name shown to payers on checkout screens and sent as the payee name when a payment is initiated with the payer's bank.

Required string length: 1 - 64

Pattern: \S

Example:

"Example Shop"

status

enum<string>

required

Only an ACTIVE merchant can take payments. Set by Equals through the CIS account status; read-only here.

Available options:

ACTIVE,

DEACTIVATED

Example:

"ACTIVE"

logoUrl

string<uri> | null

required

Stable URL of the merchant logo as shown to payers, a 512x512 PNG. null when no logo has been uploaded; payer screens show the merchant's initials instead.

Maximum string length: 2048

Example:

"https://pay.roqqett.com/api/assets-management/avatar-image/e9293471-5eb3-4dbc-916c-dbaf9e2deefd"

returnPolicyUrl

string<uri> | null

required

Link to the merchant's returns policy, shown to payers.

Maximum string length: 2048

Pattern: ^https:\/\/

Example:

"https://shop.example.com/returns"

branding

object

required

Show child attributes

brandingPermissions

object

required

What Equals has enabled the merchant to change. Only Equals can change it.

Show child attributes

canCreateTopUpCheckouts

boolean

required

Whether Equals allows the merchant to create top-up checkout sessions.

Example:

false

reconciliation

object

required

Whether Equals reconciles the merchant's payments. Only Equals can change it.

Show child attributes

paymentsSummary

object[] | null

required

One row per currency the merchant has taken a completed payment in. null unless requested with include=paymentsSummary.

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 GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/merchant?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/roqqett/merchant', 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/merchant",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.equalsmoney.com/v2/roqqett/merchant"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/roqqett/merchant")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "accountId": "F50091",
  "name": "Example Shop",
  "status": "ACTIVE",
  "logoUrl": "https://pay.roqqett.com/api/assets-management/avatar-image/e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "returnPolicyUrl": "https://shop.example.com/returns",
  "branding": {
    "primaryColour": "#1A2B3C",
    "contentOnPrimaryColour": "#1A2B3C",
    "secondaryColour": "#1A2B3C",
    "contentOnSecondaryColour": "#1A2B3C",
    "hideRoqqettLogo": true
  },
  "brandingPermissions": {
    "canCustomiseColours": true,
    "canHideRoqqettLogo": true
  },
  "canCreateTopUpCheckouts": false,
  "reconciliation": {
    "enabled": true
  },
  "paymentsSummary": [
    {
      "currencyCode": "GBP",
      "today": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      },
      "last7Days": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      },
      "last30Days": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      }
    }
  ],
  "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"
    }
  ]
}