Create a payee - Equals Documentation

POST

roqqett

payees

cURL

curl --request POST \
  --url 'https://api.equalsmoney.com/v2/roqqett/payees?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example Holdings Ltd",
  "currencyCode": "GBP",
  "bankDetails": {
    "type": "SORT_CODE",
    "sortCode": "040004",
    "accountNumber": "12345678"
  }
}
'

import requests

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

payload = {
    "name": "Example Holdings Ltd",
    "currencyCode": "GBP",
    "bankDetails": {
        "type": "SORT_CODE",
        "sortCode": "040004",
        "accountNumber": "12345678"
    }
}
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({
    name: 'Example Holdings Ltd',
    currencyCode: 'GBP',
    bankDetails: {type: 'SORT_CODE', sortCode: '040004', accountNumber: '12345678'}
  })
};

fetch('https://api.equalsmoney.com/v2/roqqett/payees', 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",
  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([
    'name' => 'Example Holdings Ltd',
    'currencyCode' => 'GBP',
    'bankDetails' => [
        'type' => 'SORT_CODE',
        'sortCode' => '040004',
        'accountNumber' => '12345678'
    ]
  ]),
  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/payees"

	payload := strings.NewReader("{\n  \"name\": \"Example Holdings Ltd\",\n  \"currencyCode\": \"GBP\",\n  \"bankDetails\": {\n    \"type\": \"SORT_CODE\",\n    \"sortCode\": \"040004\",\n    \"accountNumber\": \"12345678\"\n  }\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/payees")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Example Holdings Ltd\",\n  \"currencyCode\": \"GBP\",\n  \"bankDetails\": {\n    \"type\": \"SORT_CODE\",\n    \"sortCode\": \"040004\",\n    \"accountNumber\": \"12345678\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"Example Holdings Ltd\",\n  \"currencyCode\": \"GBP\",\n  \"bankDetails\": {\n    \"type\": \"SORT_CODE\",\n    \"sortCode\": \"040004\",\n    \"accountNumber\": \"12345678\"\n  }\n}"

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"
}

{
  "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"
    }
  ]
}

{
  "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

name

string

required

Account holder name, as the payee's bank holds it.

Required string length: 1 - 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

SORT_CODE for GBP payees, IBAN for EUR payees.

Option 1
Option 2

Show child attributes

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 POST \
  --url 'https://api.equalsmoney.com/v2/roqqett/payees?accountId={{accountId}}' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example Holdings Ltd",
  "currencyCode": "GBP",
  "bankDetails": {
    "type": "SORT_CODE",
    "sortCode": "040004",
    "accountNumber": "12345678"
  }
}
'

import requests

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

payload = {
    "name": "Example Holdings Ltd",
    "currencyCode": "GBP",
    "bankDetails": {
        "type": "SORT_CODE",
        "sortCode": "040004",
        "accountNumber": "12345678"
    }
}
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({
    name: 'Example Holdings Ltd',
    currencyCode: 'GBP',
    bankDetails: {type: 'SORT_CODE', sortCode: '040004', accountNumber: '12345678'}
  })
};

fetch('https://api.equalsmoney.com/v2/roqqett/payees', 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",
  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([
    'name' => 'Example Holdings Ltd',
    'currencyCode' => 'GBP',
    'bankDetails' => [
        'type' => 'SORT_CODE',
        'sortCode' => '040004',
        'accountNumber' => '12345678'
    ]
  ]),
  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/payees"

	payload := strings.NewReader("{\n  \"name\": \"Example Holdings Ltd\",\n  \"currencyCode\": \"GBP\",\n  \"bankDetails\": {\n    \"type\": \"SORT_CODE\",\n    \"sortCode\": \"040004\",\n    \"accountNumber\": \"12345678\"\n  }\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/payees")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Example Holdings Ltd\",\n  \"currencyCode\": \"GBP\",\n  \"bankDetails\": {\n    \"type\": \"SORT_CODE\",\n    \"sortCode\": \"040004\",\n    \"accountNumber\": \"12345678\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"Example Holdings Ltd\",\n  \"currencyCode\": \"GBP\",\n  \"bankDetails\": {\n    \"type\": \"SORT_CODE\",\n    \"sortCode\": \"040004\",\n    \"accountNumber\": \"12345678\"\n  }\n}"

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"
}

{
  "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"
    }
  ]
}

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