API de Clientes

Ver en POSTMAN

Recurso para obtener los clientes dados de alta en Increase Pay o dar de alta nuevos clientes

Cómo probar

Recuerda usar la Base URL de Sandbox para hacer pruebas: https://gateway.increase.app/pay-sandbox/public/v1/

URL Producción: https://gateway.increase.app/pay/public/v1/

Recordar siempre enviar en los headers Content-Type: application/json

Crear un cliente

POST https://gateway.increase.app/pay/public/v1/customers

Parámetro	Tipo	Descripción	Requerido
email	String	email del cliente	si
tax_id	String	CUIT/CUIL/DNI o identificador del cliente	si
billing_info	Object	Datos de Facturacion del Cliente	si
first_name	String	Nombre del cliente	si
last_name	String	Apellido del cliente	si
external_id	String	Identificador del cliente en tu sistema.	no
language	String	Lenguaje del cliente por defecto	no
timezone	String	Zona horaria del cliente	no

Dentro del campo billing_info se podrá enviar

Parámetro	Tipo	Descripción	Requerido
address_line_1	String	Linea 1 direccion del cliente	si
country	String	Pais del Cliente (ARG, CHL, COL, ECU, PER, URY, PRY, BOL, CRI, PAN, MEX, SLV, DOM, BRA)	si
city	String	Ciudad del cLiente	si
phone	String	Telefono del Cliente	si
zip_code	String	Codigo Postal del cliente	si
state_iso_code	String	Provincia del Cliente en formato ISO	solo para customers de Argentina. Default: AR-B
address_line_2	String	Linea 2 direccion del cliente	no
state	String	Provincia del Cliente	no

Valores permitidos para state_iso_code son ISO 3166

Provincia	Código ISO 3166
Ciudad Autónoma de Buenos Aires	AR-C
Buenos Aires	AR-B
Catamarca	AR-K
Chaco	AR-H
Chubut	AR-U
Córdoba	AR-X
Corrientes	AR-W
Entre Ríos	AR-E
Formosa	AR-P
Jujuy	AR-Y
La Pampa	AR-L
La Rioja	AR-F
Mendoza	AR-M
Misiones	AR-N
Neuquén	AR-Q
Río Negro	AR-R
Salta	AR-A
San Juan	AR-J
San Luis	AR-D
Santa Cruz	AR-Z
Santa Fe	AR-S
Santiago del Estero	AR-G
Tierra del Fuego	AR-V
Tucumán	AR-T

Ejemplo

Request body

{
  "external_id": "testeando",
  "email": "new_user450@test.com",
  "tax_id": "11111111",
  "language": "ES",
  "timezone": "Buenos Aires",
  "first_name": "First name",
  "last_name": "Last name",
  "billing_info": {
    "address_line_1": "El Salvador 231",
    "address_line_2": null,
    "country": "ARG",
    "city": "BS. AS.",
    "state": "Bs. As.",
    "state_iso_code": "AR-B",
    "zip_code": "1414",
    "phone": "111111"
  }
}

Response

{
  "id": "bb92c1f4-c5d5-466e-8cbc-916bcbdf9dcf",
  "external_id": null,
  "email": "new_user450@test.com",
  "tax_id": "11111111",
  "language": "ES",
  "timezone": "Buenos Aires",
  "first_name": "First name",
  "last_name": "Last name",
  "billing_info": {
    "address_line_1": "El Salvador 231",
    "address_line_2": null,
    "country": "ARG",
    "city": "BS. AS.",
    "state": "Bs. As.",
    "state_iso_code": "AR-B",
    "zip_code": "1414",
    "phone": "111111"
  },
  "checkout_link": "https://pay.increase.app/payment-method/account_id?customer_id=bb92c1f4-c5d5-466e-8cbc-916bcbdf9dcf",
  "created_at": "2020-01-09T15:02:18-03:00"
}

info

El checkout Link te permitirá enviar al cliente una URL desde donde podra agregar un nuevo método de Pago y se asociará a el mismo. Igualmente podra el cliente cargar su método de pago directamente cuando pague su primer factura o cree su primer suscripción.

Obtener todos los clientes

GET https://gateway.increase.app/pay/public/v1/customers

Parámetros

Parámetro	Tipo	Descripción	Requerido
page	Integer	Indica la página a obtener resultados.	no
per_page	Integer	Cantidad de resultados por página (Máximo 40).	no
first_name	String	Nombre del cliente	no
last_name	String	Apellido del cliente	no
email	String	Dirección de correo electrónico del cliente	no
external_id	String	Id externo cargado para el cliente	no
tax_id	String	Número de identificación tributaria del cliente	no

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "external_id": null,
      "email": "1dominic.koch@hirthe.net",
      "language": "ES",
      "timezone": "Buenos Aires",
      "first_name": null,
      "last_name": null,
      "billing_info": {
        "address_line_1": "El Salvador 231",
        "address_line_2": null,
        "country": "ARG",
        "city": "BS. AS.",
        "state": "Bs. As.",
        "state_iso_code": "AR-B",
        "zip_code": "1414",
        "phone": "111111"
      },
      "tax_id": "11111111",
      "checkout_link": "https://pay.increase.app/payment-method/00000000-0000-0000-0000-000000000001?customer_id=00000000-0000-0000-0000-000000000001",
      "created_at": "2020-01-09T15:02:18-03:00"
    }
  ],
  "current_page": 1,
  "per_page": 20,
  "total_pages": 1,
  "total_elements": 1
}

Obtener un cliente específico

GET https://gateway.increase.app/pay/public/v1/customers/<id>

Actualizar un cliente

PUT https://gateway.increase.app/pay/public/v1/customers/<id>

Puede enviarse como parámetro cualquiera de los parámetros de la creación del cliente

Obtener los métodos de pago de un cliente específico

GET https://gateway.increase.app/pay/public/v1/customers/<id>/payment_methods

Response

{
  "data": [
    {
      "id": "214177fe-54e7-465e-a31d-9d76d334c34d",
      "external_id": "8917741942",
      "data": {
        "country": "ARG",
        "number": "234567**1111",
        "type": "card",
        "cardholder_identification_type": "DNI",
        "cardholder_identification_number": "125633839",
        "expiration_month": 9,
        "expiration_year": 2023,
        "first_six_digits": "234567",
        "last_four_digits": "1111",
        "issuer_name": "Visa Argentina S.A.",
        "cardholder_name": "Juan Perez",
        "card_brand_name": "Visa Débito",
        "card_brand_payment_type_id": "debit_card"
      },
      "collect_method_id": "01de909e-9511-4d25-b435-13a68dbd0128",
      "created_at": "2020-07-29T10:23:06-03:00"
    }
  ],
  "current_page": 1,
  "per_page": 20,
  "total_pages": 1,
  "total_elements": 1
}