Crear deuda

curl --request POST \
  --url https://tapipay-facade.dev.tapila.cloud/debts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-authorization-token: <api-key>' \
  --data '
{
  "amount": 1.01,
  "dueDate": "2023-12-25",
  "externalClientId": "<string>",
  "currency": "MXN",
  "description": "<string>",
  "productName": "<string>",
  "allowOverduePayment": true,
  "allowPartialPayments": true,
  "autopay": false,
  "paymentMethods": [],
  "additionalData": {}
}
'

import requests

url = "https://tapipay-facade.dev.tapila.cloud/debts"

payload = {
    "amount": 1.01,
    "dueDate": "2023-12-25",
    "externalClientId": "<string>",
    "currency": "MXN",
    "description": "<string>",
    "productName": "<string>",
    "allowOverduePayment": True,
    "allowPartialPayments": True,
    "autopay": False,
    "paymentMethods": [],
    "additionalData": {}
}
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({
    amount: 1.01,
    dueDate: '2023-12-25',
    externalClientId: '<string>',
    currency: 'MXN',
    description: '<string>',
    productName: '<string>',
    allowOverduePayment: true,
    allowPartialPayments: true,
    autopay: false,
    paymentMethods: [],
    additionalData: {}
  })
};

fetch('https://tapipay-facade.dev.tapila.cloud/debts', 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/debts",
  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([
    'amount' => 1.01,
    'dueDate' => '2023-12-25',
    'externalClientId' => '<string>',
    'currency' => 'MXN',
    'description' => '<string>',
    'productName' => '<string>',
    'allowOverduePayment' => true,
    'allowPartialPayments' => true,
    'autopay' => false,
    'paymentMethods' => [
        
    ],
    'additionalData' => [
        
    ]
  ]),
  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/debts"

	payload := strings.NewReader("{\n  \"amount\": 1.01,\n  \"dueDate\": \"2023-12-25\",\n  \"externalClientId\": \"<string>\",\n  \"currency\": \"MXN\",\n  \"description\": \"<string>\",\n  \"productName\": \"<string>\",\n  \"allowOverduePayment\": true,\n  \"allowPartialPayments\": true,\n  \"autopay\": false,\n  \"paymentMethods\": [],\n  \"additionalData\": {}\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/debts")
  .header("x-api-key", "<api-key>")
  .header("x-authorization-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1.01,\n  \"dueDate\": \"2023-12-25\",\n  \"externalClientId\": \"<string>\",\n  \"currency\": \"MXN\",\n  \"description\": \"<string>\",\n  \"productName\": \"<string>\",\n  \"allowOverduePayment\": true,\n  \"allowPartialPayments\": true,\n  \"autopay\": false,\n  \"paymentMethods\": [],\n  \"additionalData\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tapipay-facade.dev.tapila.cloud/debts")

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  \"amount\": 1.01,\n  \"dueDate\": \"2023-12-25\",\n  \"externalClientId\": \"<string>\",\n  \"currency\": \"MXN\",\n  \"description\": \"<string>\",\n  \"productName\": \"<string>\",\n  \"allowOverduePayment\": true,\n  \"allowPartialPayments\": true,\n  \"autopay\": false,\n  \"paymentMethods\": [],\n  \"additionalData\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "debtId": "<string>",
    "externalRequestId": "<string>",
    "amount": 123,
    "amountPaid": 123,
    "currency": "MXN",
    "dueDate": "2023-12-25",
    "allowOverduePayment": true,
    "allowPartialPayments": true,
    "autopay": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "paymentMethods": [],
    "paymentUrl": "<string>",
    "contact": {
      "contactId": "<string>",
      "externalClientId": "<string>",
      "createdInline": true
    },
    "product": {
      "productId": "<string>",
      "name": "<string>",
      "active": true,
      "createdInline": true
    }
  },
  "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>"
}

POST

debts

Crear deuda

curl --request POST \
  --url https://tapipay-facade.dev.tapila.cloud/debts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-authorization-token: <api-key>' \
  --data '
{
  "amount": 1.01,
  "dueDate": "2023-12-25",
  "externalClientId": "<string>",
  "currency": "MXN",
  "description": "<string>",
  "productName": "<string>",
  "allowOverduePayment": true,
  "allowPartialPayments": true,
  "autopay": false,
  "paymentMethods": [],
  "additionalData": {}
}
'

import requests

url = "https://tapipay-facade.dev.tapila.cloud/debts"

payload = {
    "amount": 1.01,
    "dueDate": "2023-12-25",
    "externalClientId": "<string>",
    "currency": "MXN",
    "description": "<string>",
    "productName": "<string>",
    "allowOverduePayment": True,
    "allowPartialPayments": True,
    "autopay": False,
    "paymentMethods": [],
    "additionalData": {}
}
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({
    amount: 1.01,
    dueDate: '2023-12-25',
    externalClientId: '<string>',
    currency: 'MXN',
    description: '<string>',
    productName: '<string>',
    allowOverduePayment: true,
    allowPartialPayments: true,
    autopay: false,
    paymentMethods: [],
    additionalData: {}
  })
};

fetch('https://tapipay-facade.dev.tapila.cloud/debts', 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/debts",
  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([
    'amount' => 1.01,
    'dueDate' => '2023-12-25',
    'externalClientId' => '<string>',
    'currency' => 'MXN',
    'description' => '<string>',
    'productName' => '<string>',
    'allowOverduePayment' => true,
    'allowPartialPayments' => true,
    'autopay' => false,
    'paymentMethods' => [
        
    ],
    'additionalData' => [
        
    ]
  ]),
  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/debts"

	payload := strings.NewReader("{\n  \"amount\": 1.01,\n  \"dueDate\": \"2023-12-25\",\n  \"externalClientId\": \"<string>\",\n  \"currency\": \"MXN\",\n  \"description\": \"<string>\",\n  \"productName\": \"<string>\",\n  \"allowOverduePayment\": true,\n  \"allowPartialPayments\": true,\n  \"autopay\": false,\n  \"paymentMethods\": [],\n  \"additionalData\": {}\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/debts")
  .header("x-api-key", "<api-key>")
  .header("x-authorization-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1.01,\n  \"dueDate\": \"2023-12-25\",\n  \"externalClientId\": \"<string>\",\n  \"currency\": \"MXN\",\n  \"description\": \"<string>\",\n  \"productName\": \"<string>\",\n  \"allowOverduePayment\": true,\n  \"allowPartialPayments\": true,\n  \"autopay\": false,\n  \"paymentMethods\": [],\n  \"additionalData\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tapipay-facade.dev.tapila.cloud/debts")

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  \"amount\": 1.01,\n  \"dueDate\": \"2023-12-25\",\n  \"externalClientId\": \"<string>\",\n  \"currency\": \"MXN\",\n  \"description\": \"<string>\",\n  \"productName\": \"<string>\",\n  \"allowOverduePayment\": true,\n  \"allowPartialPayments\": true,\n  \"autopay\": false,\n  \"paymentMethods\": [],\n  \"additionalData\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "debtId": "<string>",
    "externalRequestId": "<string>",
    "amount": 123,
    "amountPaid": 123,
    "currency": "MXN",
    "dueDate": "2023-12-25",
    "allowOverduePayment": true,
    "allowPartialPayments": true,
    "autopay": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "paymentMethods": [],
    "paymentUrl": "<string>",
    "contact": {
      "contactId": "<string>",
      "externalClientId": "<string>",
      "createdInline": true
    },
    "product": {
      "productId": "<string>",
      "name": "<string>",
      "active": true,
      "createdInline": true
    }
  },
  "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

x-api-key

string

header

requerido

API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).

x-authorization-token

string

header

requerido

Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...

Encabezados

Idempotency-Key

string

Clave de idempotencia (opcional). Se usa como llave única (externalRequestId) de la deuda. El externalRequestId es una llave permanente sin TTL (constraint UNIQUE en el OFU). Si el cliente envía Idempotency-Key, su valor se devuelve como externalRequestId en la response. Una request repetida con la misma key devuelve error 409 RESOURCE_CONFLICT (no es replay/idempotencia clásica; es rechazo de duplicado por constraint UNIQUE). Si no se envía, el backend genera un externalRequestId único. Ver ADR-004 v1.1 para detalles de semántica.

Cuerpo

application/json

amount

number

requerido

Monto en pesos (hasta 2 decimales, mínimo 0.01)

Rango requerido: x >= 0.01Debe ser un múltiplo de 0.01

dueDate

string<date>

requerido

Fecha de vencimiento (YYYY-MM-DD)

externalClientId

string

Identificador del deudor (externalClientId o contactData, no ambos). Si contactData no se envía, este campo es obligatorio.

contactData

object

Datos completos del deudor inline. Si se envía, externalClientId no se permite. Alternativa a externalClientId.

Show child attributes

currency

enum<string>

predeterminado:MXN

Código de moneda ISO 4217 (MXN, ARS, PEN, COP, CLP, USD)

Opciones disponibles:

MXN,

ARS,

PEN,

COP,

CLP,

USD

description

string

Descripción visible al deudor (opcional)

productName

string

Nombre del producto a asociar (opcional). Se resuelve por name en el OFU o se crea inline si no existe. Identificado por name único por companyCode.

allowOverduePayment

boolean

predeterminado:true

Si false, no se puede pagar después del dueDate

allowPartialPayments

boolean

predeterminado:true

Habilita pagos parciales

autopay

boolean

predeterminado:false

Si true, la deuda se cobrará vía débito automático. No puede coexistir con paymentMethods.

paymentMethods

enum<string>[]

Medios de pago habilitados. Solo válido cuando autopay=false.

Opciones disponibles:

CASH,

CARD,

TRANSFER,

WALLET,

BANK_TRANSFER

additionalData

object

Escape hatch para datos adicionales

Respuesta

Deuda creada

data

object

Show child attributes

requestId

string

Listar deudas Obtener deuda

Contacts

Products

Debts

Subscriptions

Payment Links

Crear deuda

Autorizaciones

Encabezados

Cuerpo

Respuesta