Update a customer
curl --request PUT \
--url https://payments.oaknetwork.org/api/v1/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_number": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"tax_id": "<string>",
"dob": "2023-12-25",
"phone_country_code": "<string>",
"phone_area_code": "<string>",
"phone_number": "<string>",
"street_number": "<string>",
"street_name": "<string>",
"house_number": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"subdivision": "<string>",
"mother_name": "<string>",
"monthly_net_income": "<string>",
"owner_legal_name": "<string>",
"owner_document_number": "<string>",
"owner_document_type": "<string>",
"company_name": "<string>",
"company_start_date": "<string>",
"wallet_address": "<string>"
}
'import requests
url = "https://payments.oaknetwork.org/api/v1/customers/{id}"
payload = {
"document_number": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"tax_id": "<string>",
"dob": "2023-12-25",
"phone_country_code": "<string>",
"phone_area_code": "<string>",
"phone_number": "<string>",
"street_number": "<string>",
"street_name": "<string>",
"house_number": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"subdivision": "<string>",
"mother_name": "<string>",
"monthly_net_income": "<string>",
"owner_legal_name": "<string>",
"owner_document_number": "<string>",
"owner_document_type": "<string>",
"company_name": "<string>",
"company_start_date": "<string>",
"wallet_address": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document_number: '<string>',
email: 'jsmith@example.com',
first_name: '<string>',
last_name: '<string>',
tax_id: '<string>',
dob: '2023-12-25',
phone_country_code: '<string>',
phone_area_code: '<string>',
phone_number: '<string>',
street_number: '<string>',
street_name: '<string>',
house_number: '<string>',
postal_code: '<string>',
city: '<string>',
state: '<string>',
country_code: '<string>',
subdivision: '<string>',
mother_name: '<string>',
monthly_net_income: '<string>',
owner_legal_name: '<string>',
owner_document_number: '<string>',
owner_document_type: '<string>',
company_name: '<string>',
company_start_date: '<string>',
wallet_address: '<string>'
})
};
fetch('https://payments.oaknetwork.org/api/v1/customers/{id}', 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://payments.oaknetwork.org/api/v1/customers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'document_number' => '<string>',
'email' => 'jsmith@example.com',
'first_name' => '<string>',
'last_name' => '<string>',
'tax_id' => '<string>',
'dob' => '2023-12-25',
'phone_country_code' => '<string>',
'phone_area_code' => '<string>',
'phone_number' => '<string>',
'street_number' => '<string>',
'street_name' => '<string>',
'house_number' => '<string>',
'postal_code' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country_code' => '<string>',
'subdivision' => '<string>',
'mother_name' => '<string>',
'monthly_net_income' => '<string>',
'owner_legal_name' => '<string>',
'owner_document_number' => '<string>',
'owner_document_type' => '<string>',
'company_name' => '<string>',
'company_start_date' => '<string>',
'wallet_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://payments.oaknetwork.org/api/v1/customers/{id}"
payload := strings.NewReader("{\n \"document_number\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"phone_country_code\": \"<string>\",\n \"phone_area_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"street_number\": \"<string>\",\n \"street_name\": \"<string>\",\n \"house_number\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"monthly_net_income\": \"<string>\",\n \"owner_legal_name\": \"<string>\",\n \"owner_document_number\": \"<string>\",\n \"owner_document_type\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_start_date\": \"<string>\",\n \"wallet_address\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://payments.oaknetwork.org/api/v1/customers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_number\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"phone_country_code\": \"<string>\",\n \"phone_area_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"street_number\": \"<string>\",\n \"street_name\": \"<string>\",\n \"house_number\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"monthly_net_income\": \"<string>\",\n \"owner_legal_name\": \"<string>\",\n \"owner_document_number\": \"<string>\",\n \"owner_document_type\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_start_date\": \"<string>\",\n \"wallet_address\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://payments.oaknetwork.org/api/v1/customers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_number\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"phone_country_code\": \"<string>\",\n \"phone_area_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"street_number\": \"<string>\",\n \"street_name\": \"<string>\",\n \"house_number\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"monthly_net_income\": \"<string>\",\n \"owner_legal_name\": \"<string>\",\n \"owner_document_number\": \"<string>\",\n \"owner_document_type\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_start_date\": \"<string>\",\n \"wallet_address\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_number": "<string>",
"tax_id": "<string>",
"document_type": "<string>",
"email": "jsmith@example.com",
"social_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"dob": "2023-11-07T05:31:56Z",
"house_number": "<string>",
"street_number": "<string>",
"street_name": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"phone_country_code": "<string>",
"phone_area_code": "<string>",
"phone_number": "<string>",
"monthly_net_income": "<string>",
"gender": "<string>",
"country_code": "<string>",
"roles": [
"<string>"
],
"wallet_address": "<string>"
}
}{
"msg": "<string>",
"data": null,
"provider_message": "<string>"
}{
"msg": "Unauthorized",
"data": null
}{
"msg": "Forbidden",
"data": null
}{
"msg": "Resource not found",
"data": null
}Customers
Update a customer
Update customer details. All fields are optional.
PUT
/
api
/
v1
/
customers
/
{id}
Update a customer
curl --request PUT \
--url https://payments.oaknetwork.org/api/v1/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_number": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"tax_id": "<string>",
"dob": "2023-12-25",
"phone_country_code": "<string>",
"phone_area_code": "<string>",
"phone_number": "<string>",
"street_number": "<string>",
"street_name": "<string>",
"house_number": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"subdivision": "<string>",
"mother_name": "<string>",
"monthly_net_income": "<string>",
"owner_legal_name": "<string>",
"owner_document_number": "<string>",
"owner_document_type": "<string>",
"company_name": "<string>",
"company_start_date": "<string>",
"wallet_address": "<string>"
}
'import requests
url = "https://payments.oaknetwork.org/api/v1/customers/{id}"
payload = {
"document_number": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"tax_id": "<string>",
"dob": "2023-12-25",
"phone_country_code": "<string>",
"phone_area_code": "<string>",
"phone_number": "<string>",
"street_number": "<string>",
"street_name": "<string>",
"house_number": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country_code": "<string>",
"subdivision": "<string>",
"mother_name": "<string>",
"monthly_net_income": "<string>",
"owner_legal_name": "<string>",
"owner_document_number": "<string>",
"owner_document_type": "<string>",
"company_name": "<string>",
"company_start_date": "<string>",
"wallet_address": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document_number: '<string>',
email: 'jsmith@example.com',
first_name: '<string>',
last_name: '<string>',
tax_id: '<string>',
dob: '2023-12-25',
phone_country_code: '<string>',
phone_area_code: '<string>',
phone_number: '<string>',
street_number: '<string>',
street_name: '<string>',
house_number: '<string>',
postal_code: '<string>',
city: '<string>',
state: '<string>',
country_code: '<string>',
subdivision: '<string>',
mother_name: '<string>',
monthly_net_income: '<string>',
owner_legal_name: '<string>',
owner_document_number: '<string>',
owner_document_type: '<string>',
company_name: '<string>',
company_start_date: '<string>',
wallet_address: '<string>'
})
};
fetch('https://payments.oaknetwork.org/api/v1/customers/{id}', 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://payments.oaknetwork.org/api/v1/customers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'document_number' => '<string>',
'email' => 'jsmith@example.com',
'first_name' => '<string>',
'last_name' => '<string>',
'tax_id' => '<string>',
'dob' => '2023-12-25',
'phone_country_code' => '<string>',
'phone_area_code' => '<string>',
'phone_number' => '<string>',
'street_number' => '<string>',
'street_name' => '<string>',
'house_number' => '<string>',
'postal_code' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country_code' => '<string>',
'subdivision' => '<string>',
'mother_name' => '<string>',
'monthly_net_income' => '<string>',
'owner_legal_name' => '<string>',
'owner_document_number' => '<string>',
'owner_document_type' => '<string>',
'company_name' => '<string>',
'company_start_date' => '<string>',
'wallet_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://payments.oaknetwork.org/api/v1/customers/{id}"
payload := strings.NewReader("{\n \"document_number\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"phone_country_code\": \"<string>\",\n \"phone_area_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"street_number\": \"<string>\",\n \"street_name\": \"<string>\",\n \"house_number\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"monthly_net_income\": \"<string>\",\n \"owner_legal_name\": \"<string>\",\n \"owner_document_number\": \"<string>\",\n \"owner_document_type\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_start_date\": \"<string>\",\n \"wallet_address\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://payments.oaknetwork.org/api/v1/customers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_number\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"phone_country_code\": \"<string>\",\n \"phone_area_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"street_number\": \"<string>\",\n \"street_name\": \"<string>\",\n \"house_number\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"monthly_net_income\": \"<string>\",\n \"owner_legal_name\": \"<string>\",\n \"owner_document_number\": \"<string>\",\n \"owner_document_type\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_start_date\": \"<string>\",\n \"wallet_address\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://payments.oaknetwork.org/api/v1/customers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_number\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"phone_country_code\": \"<string>\",\n \"phone_area_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"street_number\": \"<string>\",\n \"street_name\": \"<string>\",\n \"house_number\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country_code\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"monthly_net_income\": \"<string>\",\n \"owner_legal_name\": \"<string>\",\n \"owner_document_number\": \"<string>\",\n \"owner_document_type\": \"<string>\",\n \"company_name\": \"<string>\",\n \"company_start_date\": \"<string>\",\n \"wallet_address\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_number": "<string>",
"tax_id": "<string>",
"document_type": "<string>",
"email": "jsmith@example.com",
"social_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"dob": "2023-11-07T05:31:56Z",
"house_number": "<string>",
"street_number": "<string>",
"street_name": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"phone_country_code": "<string>",
"phone_area_code": "<string>",
"phone_number": "<string>",
"monthly_net_income": "<string>",
"gender": "<string>",
"country_code": "<string>",
"roles": [
"<string>"
],
"wallet_address": "<string>"
}
}{
"msg": "<string>",
"data": null,
"provider_message": "<string>"
}{
"msg": "Unauthorized",
"data": null
}{
"msg": "Forbidden",
"data": null
}{
"msg": "Resource not found",
"data": null
}Authorizations
Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer
Path Parameters
Body
application/json
Customer registration request. Fields document_type, country_code, and gender are case-insensitive (uppercased internally, returned lowercased).
Government document number
Document type (case-insensitive)
Available options:
cpf, cnpj, passport, ssn, itin, cc, curp, personal_tax_id, company_tax_id Date of birth (ISO 8601)
ISO country code (case-insensitive)
ISO subdivision code
Gender (case-insensitive)
Available options:
male, female, other ⌘I