Create a consumer by providing it’s consumer_id
POST
/
consumers
Onboard a consumer on Paylead platform
curl --request POST \
--url https://api-{programRef}.sandbox.paylead.tech/consumers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"id": "consumer-12345",
"banks": [
{
"accounts": [
{
"id": "acc_9876543210",
"iban": "FR7630006000011234567890189",
"name": "exemple_account",
"transactions": [
{
"amount": -85.5,
"currency": "EUR",
"executed_at": "2023-07-15T14:32:45Z",
"id": "tx_12345678abcdef",
"raw_label": "PURCHASE NIKE STORE PARIS",
"type": "bank",
"account_id": "acc_9876543210",
"acquirer_reference_number": "74999912345678901234567",
"authorization_id_response": "1A2B3C",
"brand": {
"address": "1 Rue de la Paix",
"category_code": "CLOTHING",
"city": "Paris",
"country": "FR",
"id": "brand_nike",
"mcc": "5941",
"name": "Nike",
"post_code": "75001",
"public_reference": "FR0123456789"
},
"category": "shopping",
"channel": "store",
"deleted": "2026-07-01T00:00:00Z",
"is_realtime": false,
"label": "PURCHASE NIKE STORE",
"retrieval_reference_number": "1A2B3C4D5E6F",
"scheme": "visa",
"scheme_id": "019876543210987",
"state": "cleared",
"store": {
"address": "1 Rue de la Paix",
"category_code": "Clothing",
"city": "Paris",
"country": "FR",
"id": "store_123456",
"merchant_id": "merchant_nike_fr",
"name": "Nike Store",
"post_code": "75001",
"public_reference": "RCS987654321",
"terminal_id": "TERM1234"
},
"truncated_dpan": "1A2B",
"truncated_pan": "1A2B"
}
]
}
],
"bank_id": "your_bank_id",
"id": "1",
"status": "SUCCESS"
}
]
}
'import requests
url = "https://api-{programRef}.sandbox.paylead.tech/consumers"
payload = {
"id": "consumer-12345",
"banks": [
{
"accounts": [
{
"id": "acc_9876543210",
"iban": "FR7630006000011234567890189",
"name": "exemple_account",
"transactions": [
{
"amount": -85.5,
"currency": "EUR",
"executed_at": "2023-07-15T14:32:45Z",
"id": "tx_12345678abcdef",
"raw_label": "PURCHASE NIKE STORE PARIS",
"type": "bank",
"account_id": "acc_9876543210",
"acquirer_reference_number": "74999912345678901234567",
"authorization_id_response": "1A2B3C",
"brand": {
"address": "1 Rue de la Paix",
"category_code": "CLOTHING",
"city": "Paris",
"country": "FR",
"id": "brand_nike",
"mcc": "5941",
"name": "Nike",
"post_code": "75001",
"public_reference": "FR0123456789"
},
"category": "shopping",
"channel": "store",
"deleted": "2026-07-01T00:00:00Z",
"is_realtime": False,
"label": "PURCHASE NIKE STORE",
"retrieval_reference_number": "1A2B3C4D5E6F",
"scheme": "visa",
"scheme_id": "019876543210987",
"state": "cleared",
"store": {
"address": "1 Rue de la Paix",
"category_code": "Clothing",
"city": "Paris",
"country": "FR",
"id": "store_123456",
"merchant_id": "merchant_nike_fr",
"name": "Nike Store",
"post_code": "75001",
"public_reference": "RCS987654321",
"terminal_id": "TERM1234"
},
"truncated_dpan": "1A2B",
"truncated_pan": "1A2B"
}
]
}
],
"bank_id": "your_bank_id",
"id": "1",
"status": "SUCCESS"
}
]
}
headers = {
"x-api-version": "<x-api-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-version': '<x-api-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: 'consumer-12345',
banks: [
{
accounts: [
{
id: 'acc_9876543210',
iban: 'FR7630006000011234567890189',
name: 'exemple_account',
transactions: [
{
amount: -85.5,
currency: 'EUR',
executed_at: '2023-07-15T14:32:45Z',
id: 'tx_12345678abcdef',
raw_label: 'PURCHASE NIKE STORE PARIS',
type: 'bank',
account_id: 'acc_9876543210',
acquirer_reference_number: '74999912345678901234567',
authorization_id_response: '1A2B3C',
brand: {
address: '1 Rue de la Paix',
category_code: 'CLOTHING',
city: 'Paris',
country: 'FR',
id: 'brand_nike',
mcc: '5941',
name: 'Nike',
post_code: '75001',
public_reference: 'FR0123456789'
},
category: 'shopping',
channel: 'store',
deleted: '2026-07-01T00:00:00Z',
is_realtime: false,
label: 'PURCHASE NIKE STORE',
retrieval_reference_number: '1A2B3C4D5E6F',
scheme: 'visa',
scheme_id: '019876543210987',
state: 'cleared',
store: {
address: '1 Rue de la Paix',
category_code: 'Clothing',
city: 'Paris',
country: 'FR',
id: 'store_123456',
merchant_id: 'merchant_nike_fr',
name: 'Nike Store',
post_code: '75001',
public_reference: 'RCS987654321',
terminal_id: 'TERM1234'
},
truncated_dpan: '1A2B',
truncated_pan: '1A2B'
}
]
}
],
bank_id: 'your_bank_id',
id: '1',
status: 'SUCCESS'
}
]
})
};
fetch('https://api-{programRef}.sandbox.paylead.tech/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-{programRef}.sandbox.paylead.tech/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([
'id' => 'consumer-12345',
'banks' => [
[
'accounts' => [
[
'id' => 'acc_9876543210',
'iban' => 'FR7630006000011234567890189',
'name' => 'exemple_account',
'transactions' => [
[
'amount' => -85.5,
'currency' => 'EUR',
'executed_at' => '2023-07-15T14:32:45Z',
'id' => 'tx_12345678abcdef',
'raw_label' => 'PURCHASE NIKE STORE PARIS',
'type' => 'bank',
'account_id' => 'acc_9876543210',
'acquirer_reference_number' => '74999912345678901234567',
'authorization_id_response' => '1A2B3C',
'brand' => [
'address' => '1 Rue de la Paix',
'category_code' => 'CLOTHING',
'city' => 'Paris',
'country' => 'FR',
'id' => 'brand_nike',
'mcc' => '5941',
'name' => 'Nike',
'post_code' => '75001',
'public_reference' => 'FR0123456789'
],
'category' => 'shopping',
'channel' => 'store',
'deleted' => '2026-07-01T00:00:00Z',
'is_realtime' => false,
'label' => 'PURCHASE NIKE STORE',
'retrieval_reference_number' => '1A2B3C4D5E6F',
'scheme' => 'visa',
'scheme_id' => '019876543210987',
'state' => 'cleared',
'store' => [
'address' => '1 Rue de la Paix',
'category_code' => 'Clothing',
'city' => 'Paris',
'country' => 'FR',
'id' => 'store_123456',
'merchant_id' => 'merchant_nike_fr',
'name' => 'Nike Store',
'post_code' => '75001',
'public_reference' => 'RCS987654321',
'terminal_id' => 'TERM1234'
],
'truncated_dpan' => '1A2B',
'truncated_pan' => '1A2B'
]
]
]
],
'bank_id' => 'your_bank_id',
'id' => '1',
'status' => 'SUCCESS'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-api-version: <x-api-version>"
],
]);
$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-{programRef}.sandbox.paylead.tech/consumers"
payload := strings.NewReader("{\n \"id\": \"consumer-12345\",\n \"banks\": [\n {\n \"accounts\": [\n {\n \"id\": \"acc_9876543210\",\n \"iban\": \"FR7630006000011234567890189\",\n \"name\": \"exemple_account\",\n \"transactions\": [\n {\n \"amount\": -85.5,\n \"currency\": \"EUR\",\n \"executed_at\": \"2023-07-15T14:32:45Z\",\n \"id\": \"tx_12345678abcdef\",\n \"raw_label\": \"PURCHASE NIKE STORE PARIS\",\n \"type\": \"bank\",\n \"account_id\": \"acc_9876543210\",\n \"acquirer_reference_number\": \"74999912345678901234567\",\n \"authorization_id_response\": \"1A2B3C\",\n \"brand\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"CLOTHING\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"brand_nike\",\n \"mcc\": \"5941\",\n \"name\": \"Nike\",\n \"post_code\": \"75001\",\n \"public_reference\": \"FR0123456789\"\n },\n \"category\": \"shopping\",\n \"channel\": \"store\",\n \"deleted\": \"2026-07-01T00:00:00Z\",\n \"is_realtime\": false,\n \"label\": \"PURCHASE NIKE STORE\",\n \"retrieval_reference_number\": \"1A2B3C4D5E6F\",\n \"scheme\": \"visa\",\n \"scheme_id\": \"019876543210987\",\n \"state\": \"cleared\",\n \"store\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"Clothing\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"store_123456\",\n \"merchant_id\": \"merchant_nike_fr\",\n \"name\": \"Nike Store\",\n \"post_code\": \"75001\",\n \"public_reference\": \"RCS987654321\",\n \"terminal_id\": \"TERM1234\"\n },\n \"truncated_dpan\": \"1A2B\",\n \"truncated_pan\": \"1A2B\"\n }\n ]\n }\n ],\n \"bank_id\": \"your_bank_id\",\n \"id\": \"1\",\n \"status\": \"SUCCESS\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-version", "<x-api-version>")
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-{programRef}.sandbox.paylead.tech/consumers")
.header("x-api-version", "<x-api-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"consumer-12345\",\n \"banks\": [\n {\n \"accounts\": [\n {\n \"id\": \"acc_9876543210\",\n \"iban\": \"FR7630006000011234567890189\",\n \"name\": \"exemple_account\",\n \"transactions\": [\n {\n \"amount\": -85.5,\n \"currency\": \"EUR\",\n \"executed_at\": \"2023-07-15T14:32:45Z\",\n \"id\": \"tx_12345678abcdef\",\n \"raw_label\": \"PURCHASE NIKE STORE PARIS\",\n \"type\": \"bank\",\n \"account_id\": \"acc_9876543210\",\n \"acquirer_reference_number\": \"74999912345678901234567\",\n \"authorization_id_response\": \"1A2B3C\",\n \"brand\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"CLOTHING\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"brand_nike\",\n \"mcc\": \"5941\",\n \"name\": \"Nike\",\n \"post_code\": \"75001\",\n \"public_reference\": \"FR0123456789\"\n },\n \"category\": \"shopping\",\n \"channel\": \"store\",\n \"deleted\": \"2026-07-01T00:00:00Z\",\n \"is_realtime\": false,\n \"label\": \"PURCHASE NIKE STORE\",\n \"retrieval_reference_number\": \"1A2B3C4D5E6F\",\n \"scheme\": \"visa\",\n \"scheme_id\": \"019876543210987\",\n \"state\": \"cleared\",\n \"store\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"Clothing\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"store_123456\",\n \"merchant_id\": \"merchant_nike_fr\",\n \"name\": \"Nike Store\",\n \"post_code\": \"75001\",\n \"public_reference\": \"RCS987654321\",\n \"terminal_id\": \"TERM1234\"\n },\n \"truncated_dpan\": \"1A2B\",\n \"truncated_pan\": \"1A2B\"\n }\n ]\n }\n ],\n \"bank_id\": \"your_bank_id\",\n \"id\": \"1\",\n \"status\": \"SUCCESS\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{programRef}.sandbox.paylead.tech/consumers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"consumer-12345\",\n \"banks\": [\n {\n \"accounts\": [\n {\n \"id\": \"acc_9876543210\",\n \"iban\": \"FR7630006000011234567890189\",\n \"name\": \"exemple_account\",\n \"transactions\": [\n {\n \"amount\": -85.5,\n \"currency\": \"EUR\",\n \"executed_at\": \"2023-07-15T14:32:45Z\",\n \"id\": \"tx_12345678abcdef\",\n \"raw_label\": \"PURCHASE NIKE STORE PARIS\",\n \"type\": \"bank\",\n \"account_id\": \"acc_9876543210\",\n \"acquirer_reference_number\": \"74999912345678901234567\",\n \"authorization_id_response\": \"1A2B3C\",\n \"brand\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"CLOTHING\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"brand_nike\",\n \"mcc\": \"5941\",\n \"name\": \"Nike\",\n \"post_code\": \"75001\",\n \"public_reference\": \"FR0123456789\"\n },\n \"category\": \"shopping\",\n \"channel\": \"store\",\n \"deleted\": \"2026-07-01T00:00:00Z\",\n \"is_realtime\": false,\n \"label\": \"PURCHASE NIKE STORE\",\n \"retrieval_reference_number\": \"1A2B3C4D5E6F\",\n \"scheme\": \"visa\",\n \"scheme_id\": \"019876543210987\",\n \"state\": \"cleared\",\n \"store\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"Clothing\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"store_123456\",\n \"merchant_id\": \"merchant_nike_fr\",\n \"name\": \"Nike Store\",\n \"post_code\": \"75001\",\n \"public_reference\": \"RCS987654321\",\n \"terminal_id\": \"TERM1234\"\n },\n \"truncated_dpan\": \"1A2B\",\n \"truncated_pan\": \"1A2B\"\n }\n ]\n }\n ],\n \"bank_id\": \"your_bank_id\",\n \"id\": \"1\",\n \"status\": \"SUCCESS\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "consumer-12345"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Body
application/json
Unique identifier for a consumer on your system, alphanumeric string with optional dashes or underscores
Required string length:
2 - 100Pattern:
^[a-zA-Z0-9_-]+$Example:
"consumer-12345"
Optional bank connections to attach to the consumer at onboarding time. When omitted, the consumer is created without any bank connection.
Show child attributes
Show child attributes
Response
Successful Response
Unique identifier for a consumer on your system, alphanumeric string with optional dashes or underscores
Pattern:
^[a-zA-Z0-9_-]+$Example:
"consumer-12345"
Was this page helpful?
⌘I
Onboard a consumer on Paylead platform
curl --request POST \
--url https://api-{programRef}.sandbox.paylead.tech/consumers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"id": "consumer-12345",
"banks": [
{
"accounts": [
{
"id": "acc_9876543210",
"iban": "FR7630006000011234567890189",
"name": "exemple_account",
"transactions": [
{
"amount": -85.5,
"currency": "EUR",
"executed_at": "2023-07-15T14:32:45Z",
"id": "tx_12345678abcdef",
"raw_label": "PURCHASE NIKE STORE PARIS",
"type": "bank",
"account_id": "acc_9876543210",
"acquirer_reference_number": "74999912345678901234567",
"authorization_id_response": "1A2B3C",
"brand": {
"address": "1 Rue de la Paix",
"category_code": "CLOTHING",
"city": "Paris",
"country": "FR",
"id": "brand_nike",
"mcc": "5941",
"name": "Nike",
"post_code": "75001",
"public_reference": "FR0123456789"
},
"category": "shopping",
"channel": "store",
"deleted": "2026-07-01T00:00:00Z",
"is_realtime": false,
"label": "PURCHASE NIKE STORE",
"retrieval_reference_number": "1A2B3C4D5E6F",
"scheme": "visa",
"scheme_id": "019876543210987",
"state": "cleared",
"store": {
"address": "1 Rue de la Paix",
"category_code": "Clothing",
"city": "Paris",
"country": "FR",
"id": "store_123456",
"merchant_id": "merchant_nike_fr",
"name": "Nike Store",
"post_code": "75001",
"public_reference": "RCS987654321",
"terminal_id": "TERM1234"
},
"truncated_dpan": "1A2B",
"truncated_pan": "1A2B"
}
]
}
],
"bank_id": "your_bank_id",
"id": "1",
"status": "SUCCESS"
}
]
}
'import requests
url = "https://api-{programRef}.sandbox.paylead.tech/consumers"
payload = {
"id": "consumer-12345",
"banks": [
{
"accounts": [
{
"id": "acc_9876543210",
"iban": "FR7630006000011234567890189",
"name": "exemple_account",
"transactions": [
{
"amount": -85.5,
"currency": "EUR",
"executed_at": "2023-07-15T14:32:45Z",
"id": "tx_12345678abcdef",
"raw_label": "PURCHASE NIKE STORE PARIS",
"type": "bank",
"account_id": "acc_9876543210",
"acquirer_reference_number": "74999912345678901234567",
"authorization_id_response": "1A2B3C",
"brand": {
"address": "1 Rue de la Paix",
"category_code": "CLOTHING",
"city": "Paris",
"country": "FR",
"id": "brand_nike",
"mcc": "5941",
"name": "Nike",
"post_code": "75001",
"public_reference": "FR0123456789"
},
"category": "shopping",
"channel": "store",
"deleted": "2026-07-01T00:00:00Z",
"is_realtime": False,
"label": "PURCHASE NIKE STORE",
"retrieval_reference_number": "1A2B3C4D5E6F",
"scheme": "visa",
"scheme_id": "019876543210987",
"state": "cleared",
"store": {
"address": "1 Rue de la Paix",
"category_code": "Clothing",
"city": "Paris",
"country": "FR",
"id": "store_123456",
"merchant_id": "merchant_nike_fr",
"name": "Nike Store",
"post_code": "75001",
"public_reference": "RCS987654321",
"terminal_id": "TERM1234"
},
"truncated_dpan": "1A2B",
"truncated_pan": "1A2B"
}
]
}
],
"bank_id": "your_bank_id",
"id": "1",
"status": "SUCCESS"
}
]
}
headers = {
"x-api-version": "<x-api-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-version': '<x-api-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
id: 'consumer-12345',
banks: [
{
accounts: [
{
id: 'acc_9876543210',
iban: 'FR7630006000011234567890189',
name: 'exemple_account',
transactions: [
{
amount: -85.5,
currency: 'EUR',
executed_at: '2023-07-15T14:32:45Z',
id: 'tx_12345678abcdef',
raw_label: 'PURCHASE NIKE STORE PARIS',
type: 'bank',
account_id: 'acc_9876543210',
acquirer_reference_number: '74999912345678901234567',
authorization_id_response: '1A2B3C',
brand: {
address: '1 Rue de la Paix',
category_code: 'CLOTHING',
city: 'Paris',
country: 'FR',
id: 'brand_nike',
mcc: '5941',
name: 'Nike',
post_code: '75001',
public_reference: 'FR0123456789'
},
category: 'shopping',
channel: 'store',
deleted: '2026-07-01T00:00:00Z',
is_realtime: false,
label: 'PURCHASE NIKE STORE',
retrieval_reference_number: '1A2B3C4D5E6F',
scheme: 'visa',
scheme_id: '019876543210987',
state: 'cleared',
store: {
address: '1 Rue de la Paix',
category_code: 'Clothing',
city: 'Paris',
country: 'FR',
id: 'store_123456',
merchant_id: 'merchant_nike_fr',
name: 'Nike Store',
post_code: '75001',
public_reference: 'RCS987654321',
terminal_id: 'TERM1234'
},
truncated_dpan: '1A2B',
truncated_pan: '1A2B'
}
]
}
],
bank_id: 'your_bank_id',
id: '1',
status: 'SUCCESS'
}
]
})
};
fetch('https://api-{programRef}.sandbox.paylead.tech/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-{programRef}.sandbox.paylead.tech/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([
'id' => 'consumer-12345',
'banks' => [
[
'accounts' => [
[
'id' => 'acc_9876543210',
'iban' => 'FR7630006000011234567890189',
'name' => 'exemple_account',
'transactions' => [
[
'amount' => -85.5,
'currency' => 'EUR',
'executed_at' => '2023-07-15T14:32:45Z',
'id' => 'tx_12345678abcdef',
'raw_label' => 'PURCHASE NIKE STORE PARIS',
'type' => 'bank',
'account_id' => 'acc_9876543210',
'acquirer_reference_number' => '74999912345678901234567',
'authorization_id_response' => '1A2B3C',
'brand' => [
'address' => '1 Rue de la Paix',
'category_code' => 'CLOTHING',
'city' => 'Paris',
'country' => 'FR',
'id' => 'brand_nike',
'mcc' => '5941',
'name' => 'Nike',
'post_code' => '75001',
'public_reference' => 'FR0123456789'
],
'category' => 'shopping',
'channel' => 'store',
'deleted' => '2026-07-01T00:00:00Z',
'is_realtime' => false,
'label' => 'PURCHASE NIKE STORE',
'retrieval_reference_number' => '1A2B3C4D5E6F',
'scheme' => 'visa',
'scheme_id' => '019876543210987',
'state' => 'cleared',
'store' => [
'address' => '1 Rue de la Paix',
'category_code' => 'Clothing',
'city' => 'Paris',
'country' => 'FR',
'id' => 'store_123456',
'merchant_id' => 'merchant_nike_fr',
'name' => 'Nike Store',
'post_code' => '75001',
'public_reference' => 'RCS987654321',
'terminal_id' => 'TERM1234'
],
'truncated_dpan' => '1A2B',
'truncated_pan' => '1A2B'
]
]
]
],
'bank_id' => 'your_bank_id',
'id' => '1',
'status' => 'SUCCESS'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-api-version: <x-api-version>"
],
]);
$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-{programRef}.sandbox.paylead.tech/consumers"
payload := strings.NewReader("{\n \"id\": \"consumer-12345\",\n \"banks\": [\n {\n \"accounts\": [\n {\n \"id\": \"acc_9876543210\",\n \"iban\": \"FR7630006000011234567890189\",\n \"name\": \"exemple_account\",\n \"transactions\": [\n {\n \"amount\": -85.5,\n \"currency\": \"EUR\",\n \"executed_at\": \"2023-07-15T14:32:45Z\",\n \"id\": \"tx_12345678abcdef\",\n \"raw_label\": \"PURCHASE NIKE STORE PARIS\",\n \"type\": \"bank\",\n \"account_id\": \"acc_9876543210\",\n \"acquirer_reference_number\": \"74999912345678901234567\",\n \"authorization_id_response\": \"1A2B3C\",\n \"brand\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"CLOTHING\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"brand_nike\",\n \"mcc\": \"5941\",\n \"name\": \"Nike\",\n \"post_code\": \"75001\",\n \"public_reference\": \"FR0123456789\"\n },\n \"category\": \"shopping\",\n \"channel\": \"store\",\n \"deleted\": \"2026-07-01T00:00:00Z\",\n \"is_realtime\": false,\n \"label\": \"PURCHASE NIKE STORE\",\n \"retrieval_reference_number\": \"1A2B3C4D5E6F\",\n \"scheme\": \"visa\",\n \"scheme_id\": \"019876543210987\",\n \"state\": \"cleared\",\n \"store\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"Clothing\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"store_123456\",\n \"merchant_id\": \"merchant_nike_fr\",\n \"name\": \"Nike Store\",\n \"post_code\": \"75001\",\n \"public_reference\": \"RCS987654321\",\n \"terminal_id\": \"TERM1234\"\n },\n \"truncated_dpan\": \"1A2B\",\n \"truncated_pan\": \"1A2B\"\n }\n ]\n }\n ],\n \"bank_id\": \"your_bank_id\",\n \"id\": \"1\",\n \"status\": \"SUCCESS\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-version", "<x-api-version>")
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-{programRef}.sandbox.paylead.tech/consumers")
.header("x-api-version", "<x-api-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"consumer-12345\",\n \"banks\": [\n {\n \"accounts\": [\n {\n \"id\": \"acc_9876543210\",\n \"iban\": \"FR7630006000011234567890189\",\n \"name\": \"exemple_account\",\n \"transactions\": [\n {\n \"amount\": -85.5,\n \"currency\": \"EUR\",\n \"executed_at\": \"2023-07-15T14:32:45Z\",\n \"id\": \"tx_12345678abcdef\",\n \"raw_label\": \"PURCHASE NIKE STORE PARIS\",\n \"type\": \"bank\",\n \"account_id\": \"acc_9876543210\",\n \"acquirer_reference_number\": \"74999912345678901234567\",\n \"authorization_id_response\": \"1A2B3C\",\n \"brand\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"CLOTHING\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"brand_nike\",\n \"mcc\": \"5941\",\n \"name\": \"Nike\",\n \"post_code\": \"75001\",\n \"public_reference\": \"FR0123456789\"\n },\n \"category\": \"shopping\",\n \"channel\": \"store\",\n \"deleted\": \"2026-07-01T00:00:00Z\",\n \"is_realtime\": false,\n \"label\": \"PURCHASE NIKE STORE\",\n \"retrieval_reference_number\": \"1A2B3C4D5E6F\",\n \"scheme\": \"visa\",\n \"scheme_id\": \"019876543210987\",\n \"state\": \"cleared\",\n \"store\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"Clothing\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"store_123456\",\n \"merchant_id\": \"merchant_nike_fr\",\n \"name\": \"Nike Store\",\n \"post_code\": \"75001\",\n \"public_reference\": \"RCS987654321\",\n \"terminal_id\": \"TERM1234\"\n },\n \"truncated_dpan\": \"1A2B\",\n \"truncated_pan\": \"1A2B\"\n }\n ]\n }\n ],\n \"bank_id\": \"your_bank_id\",\n \"id\": \"1\",\n \"status\": \"SUCCESS\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-{programRef}.sandbox.paylead.tech/consumers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"consumer-12345\",\n \"banks\": [\n {\n \"accounts\": [\n {\n \"id\": \"acc_9876543210\",\n \"iban\": \"FR7630006000011234567890189\",\n \"name\": \"exemple_account\",\n \"transactions\": [\n {\n \"amount\": -85.5,\n \"currency\": \"EUR\",\n \"executed_at\": \"2023-07-15T14:32:45Z\",\n \"id\": \"tx_12345678abcdef\",\n \"raw_label\": \"PURCHASE NIKE STORE PARIS\",\n \"type\": \"bank\",\n \"account_id\": \"acc_9876543210\",\n \"acquirer_reference_number\": \"74999912345678901234567\",\n \"authorization_id_response\": \"1A2B3C\",\n \"brand\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"CLOTHING\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"brand_nike\",\n \"mcc\": \"5941\",\n \"name\": \"Nike\",\n \"post_code\": \"75001\",\n \"public_reference\": \"FR0123456789\"\n },\n \"category\": \"shopping\",\n \"channel\": \"store\",\n \"deleted\": \"2026-07-01T00:00:00Z\",\n \"is_realtime\": false,\n \"label\": \"PURCHASE NIKE STORE\",\n \"retrieval_reference_number\": \"1A2B3C4D5E6F\",\n \"scheme\": \"visa\",\n \"scheme_id\": \"019876543210987\",\n \"state\": \"cleared\",\n \"store\": {\n \"address\": \"1 Rue de la Paix\",\n \"category_code\": \"Clothing\",\n \"city\": \"Paris\",\n \"country\": \"FR\",\n \"id\": \"store_123456\",\n \"merchant_id\": \"merchant_nike_fr\",\n \"name\": \"Nike Store\",\n \"post_code\": \"75001\",\n \"public_reference\": \"RCS987654321\",\n \"terminal_id\": \"TERM1234\"\n },\n \"truncated_dpan\": \"1A2B\",\n \"truncated_pan\": \"1A2B\"\n }\n ]\n }\n ],\n \"bank_id\": \"your_bank_id\",\n \"id\": \"1\",\n \"status\": \"SUCCESS\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "consumer-12345"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}{
"code": "PL-4XX-YY",
"status": 400,
"title": "The request was invalid.",
"errors": [
{
"loc": [
"body",
"field"
],
"msg": "Field required",
"type": "missing"
}
],
"instance": "api/resource/424242"
}