Skip to main content
POST
/
v2
/
customers
Create a Customer
curl --request POST \
  --url https://api.pagou.ai/v2/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "externalRef": "<string>",
  "ip_address": "<string>"
}
'
import requests

url = "https://api.pagou.ai/v2/customers"

payload = {
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "externalRef": "<string>",
    "ip_address": "<string>"
}
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({
    name: '<string>',
    email: 'jsmith@example.com',
    phone: '<string>',
    externalRef: '<string>',
    ip_address: '<string>'
  })
};

fetch('https://api.pagou.ai/v2/customers', 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.pagou.ai/v2/customers",
  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' => '<string>',
    'email' => 'jsmith@example.com',
    'phone' => '<string>',
    'externalRef' => '<string>',
    'ip_address' => '<string>'
  ]),
  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.pagou.ai/v2/customers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"externalRef\": \"<string>\",\n  \"ip_address\": \"<string>\"\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.pagou.ai/v2/customers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"externalRef\": \"<string>\",\n  \"ip_address\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.pagou.ai/v2/customers")

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  \"name\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"externalRef\": \"<string>\",\n  \"ip_address\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

Full name of the customer.

Minimum string length: 1
​
email
string<email>
required

Primary email address of the customer.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
document
object

Optional government-issued document information for the customer.

​
phone
string

Optional customer phone number in E.164-like numeric format with 11 digits.

Pattern: ^\d{11}$
​
externalRef
string

Optional external reference from your system used to correlate this customer.

​
address
object

Optional billing or residential address of the customer.

​
ip_address
string

Optional IP address associated with the customer creation request.

Response

Success

Generic success response payload.