Retrieve a payee - Equals Documentation

GET

roqqett

payees

{payeeId}

cURL

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

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

fetch('https://api.equalsmoney.com/v2/roqqett/payees/{payeeId}', 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/payees/{payeeId}",
  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/payees/{payeeId}"

	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/payees/{payeeId}")

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

{
  "id": "d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57",
  "name": "Example Holdings Ltd",
  "currencyCode": "GBP",
  "bankDetails": {
    "type": "SORT_CODE",
    "sortCode": "040004",
    "accountNumberLastFour": "5678"
  },
  "approvalStatus": "APPROVED",
  "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"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

payeeId

string<uuid>

required

The ID of a payee: the bank account a top-up checkout session pays into.

Maximum string length: 36

Example:

"d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57"

Query Parameters

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

Response

string<uuid>

required

The ID of a payee: the bank account a top-up checkout session pays into.

Maximum string length: 36

Example:

"d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57"

name

string

required

Account holder name.

Maximum string length: 140

Example:

"Example Holdings Ltd"

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

approvalStatus

enum<string>

required

Only an APPROVED payee can be paid. A new payee is APPROVED automatically only when Equals has given the merchant the top-up permission (canCreateTopUpCheckouts) or the payee 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"

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/payees/{payeeId}?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

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

fetch('https://api.equalsmoney.com/v2/roqqett/payees/{payeeId}', 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/payees/{payeeId}",
  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/payees/{payeeId}"

	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/payees/{payeeId}")

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

{
  "id": "d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57",
  "name": "Example Holdings Ltd",
  "currencyCode": "GBP",
  "bankDetails": {
    "type": "SORT_CODE",
    "sortCode": "040004",
    "accountNumberLastFour": "5678"
  },
  "approvalStatus": "APPROVED",
  "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"
    }
  ]
}