Crear contacto
curl --request POST \
--url https://tapipay-facade.dev.tapila.cloud/contacts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-authorization-token: <api-key>' \
--data '
{
"externalClientId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phones": [
{
"number": "<string>",
"primary": false,
"description": "<string>"
}
]
}
'import requests
url = "https://tapipay-facade.dev.tapila.cloud/contacts"
payload = {
"externalClientId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phones": [
{
"number": "<string>",
"primary": False,
"description": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"x-authorization-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-authorization-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalClientId: '<string>',
name: '<string>',
email: 'jsmith@example.com',
phones: [{number: '<string>', primary: false, description: '<string>'}]
})
};
fetch('https://tapipay-facade.dev.tapila.cloud/contacts', 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://tapipay-facade.dev.tapila.cloud/contacts",
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([
'externalClientId' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com',
'phones' => [
[
'number' => '<string>',
'primary' => false,
'description' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-authorization-token: <api-key>"
],
]);
$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://tapipay-facade.dev.tapila.cloud/contacts"
payload := strings.NewReader("{\n \"externalClientId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phones\": [\n {\n \"number\": \"<string>\",\n \"primary\": false,\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-authorization-token", "<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://tapipay-facade.dev.tapila.cloud/contacts")
.header("x-api-key", "<api-key>")
.header("x-authorization-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalClientId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phones\": [\n {\n \"number\": \"<string>\",\n \"primary\": false,\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tapipay-facade.dev.tapila.cloud/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-authorization-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalClientId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phones\": [\n {\n \"number\": \"<string>\",\n \"primary\": false,\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contactId": "<string>",
"externalClientId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phones": [
{
"number": "<string>",
"primary": false,
"description": "<string>"
}
],
"active": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}Contacts
Crear contacto
Registra un deudor reutilizable con su externalClientId, nombre y email.
POST
/
contacts
Crear contacto
curl --request POST \
--url https://tapipay-facade.dev.tapila.cloud/contacts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-authorization-token: <api-key>' \
--data '
{
"externalClientId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phones": [
{
"number": "<string>",
"primary": false,
"description": "<string>"
}
]
}
'import requests
url = "https://tapipay-facade.dev.tapila.cloud/contacts"
payload = {
"externalClientId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phones": [
{
"number": "<string>",
"primary": False,
"description": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"x-authorization-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-authorization-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalClientId: '<string>',
name: '<string>',
email: 'jsmith@example.com',
phones: [{number: '<string>', primary: false, description: '<string>'}]
})
};
fetch('https://tapipay-facade.dev.tapila.cloud/contacts', 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://tapipay-facade.dev.tapila.cloud/contacts",
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([
'externalClientId' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com',
'phones' => [
[
'number' => '<string>',
'primary' => false,
'description' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-authorization-token: <api-key>"
],
]);
$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://tapipay-facade.dev.tapila.cloud/contacts"
payload := strings.NewReader("{\n \"externalClientId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phones\": [\n {\n \"number\": \"<string>\",\n \"primary\": false,\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-authorization-token", "<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://tapipay-facade.dev.tapila.cloud/contacts")
.header("x-api-key", "<api-key>")
.header("x-authorization-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalClientId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phones\": [\n {\n \"number\": \"<string>\",\n \"primary\": false,\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://tapipay-facade.dev.tapila.cloud/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-authorization-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalClientId\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phones\": [\n {\n \"number\": \"<string>\",\n \"primary\": false,\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contactId": "<string>",
"externalClientId": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phones": [
{
"number": "<string>",
"primary": false,
"description": "<string>"
}
],
"active": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}{
"error": {
"message": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
},
"requestId": "<string>"
}Autorizaciones
API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).
Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...
Cuerpo
application/json
⌘I

