Skip to main content
POST
/
connectors
/
consumers
Create Consumer
curl --request POST \
  --url https://api.sandbox.paylead.tech/connectors/consumers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "banks": "<unknown>",
  "extra_consents": [],
  "id": "<string>",
  "removed_consents": []
}
'
import requests

url = "https://api.sandbox.paylead.tech/connectors/consumers"

payload = {
    "banks": "<unknown>",
    "extra_consents": [],
    "id": "<string>",
    "removed_consents": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({banks: '<unknown>', extra_consents: [], id: '<string>', removed_consents: []})
};

fetch('https://api.sandbox.paylead.tech/connectors/consumers', 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.sandbox.paylead.tech/connectors/consumers",
  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([
    'banks' => '<unknown>',
    'extra_consents' => [
        
    ],
    'id' => '<string>',
    'removed_consents' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.sandbox.paylead.tech/connectors/consumers"

	payload := strings.NewReader("{\n  \"banks\": \"<unknown>\",\n  \"extra_consents\": [],\n  \"id\": \"<string>\",\n  \"removed_consents\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.sandbox.paylead.tech/connectors/consumers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"banks\": \"<unknown>\",\n  \"extra_consents\": [],\n  \"id\": \"<string>\",\n  \"removed_consents\": []\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.paylead.tech/connectors/consumers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"banks\": \"<unknown>\",\n  \"extra_consents\": [],\n  \"id\": \"<string>\",\n  \"removed_consents\": []\n}"

response = http.request(request)
puts response.read_body
{
  "id": "ConsumerId123"
}
{
  "errors": {},
  "id": "e2c32b4b-de61-459b-accf-a75f76247946"
}
{
  "errors": {},
  "id": "e2c32b4b-de61-459b-accf-a75f76247946"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
banks
any

optional array of banks, containing bank_id and accounts ids associated.

​
extra_consents
enum<string>[]

optional array of explicit consent levels the consumer wants to opt-in.

Available options:
TRANSACTION_TRIGGERS,
TARGETING,
STATISTICS,
SMART_RANKING
​
id
string
​
removed_consents
enum<string>[]

optional array of consent levels the consumer wants to opt-out.

Available options:
TRANSACTION_TRIGGERS,
TARGETING,
STATISTICS,
SMART_RANKING

Response

Created

​
id
string
read-only

The consumer_id of the created consumer.

Example:

"ConsumerId123"