Skip to main content

API de Clientes

Si ya estás gestionando tus suscripciones con Increase Pay contactate con soporte.pay@increase.app. Si queres sumarte, comunicate con pay@increase.app.

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

A partir del próximo 15 de Enero 2021 los siguientes campos serán obligatorios: tax_id, address_line_1, country, city, zip_code

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

Headers

Content-Type: application/json
Authorization: Bearer <access_token>
ParámetroTipoDescripción
email*Stringemail del cliente
external_idStringIdentificador del cliente en tu sistema.
languageStringLenguaje del cliente por defecto
timezoneStringZona horaria del cliente
first_nameStringNombre del cliente
last_nameStringApellido del cliente
tax_id*StringCUIT/CUIL/DNI o identificador del cliente
billing_info*ObjectDatos de Facturacion del Cliente

Dentro de los campos de Facturación se podrá enviar

ParámetroTipoDescripción
address_line_1*StringLinea 1 direccion del cliente
address_line_2StringLinea 2 direccion del cliente
country*StringPais del Cliente (ARG, CHL, COL, ECU, PER, URY, PRY, BOL, CRI, PAN, MEX, SLV, DOM, BRA)
city*StringCiudad del cLiente
stateStringProvincia del Cliente
state_iso_codeStringProvincia del Cliente en formato ISO
zip_code*StringCodigo Postal del cliente
phone*StringTelefono del Cliente

Los parámetros con * son obligatorios

Para clientes de Argentina el parametro state_iso_code es requerido. En caso de no proveer este valor se setea AR-B como valor por defecto.

Valores permitidos para state_iso_code
ProvinciaCodigo ISO
Ciudad Autónoma de Buenos AiresAR-C
Buenos AiresAR-B
CatamarcaAR-K
ChacoAR-H
ChubutAR-U
CórdobaAR-X
CorrientesAR-W
Entre RíosAR-E
FormosaAR-P
JujuyAR-Y
La PampaAR-L
La RiojaAR-F
MendozaAR-M
MisionesAR-N
NeuquénAR-Q
Río NegroAR-R
SaltaAR-A
San JuanAR-J
San LuisAR-D
Santa CruzAR-Z
Santa FeAR-S
Santiago del EsteroAR-G
Tierra del FuegoAR-V
TucumánAR-T

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"
}

El checkout Link te permitirá enviar al cliente una URL desde donde podra agregar un nuevo metodo de Pago y se asociará a el mismo. Igualmente podra el cliente cargar su metodo 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

Headers

Content-Type: application/json
Authorization: Bearer <access_token>

Parámetros optativos

ParámetroTipoDescripción
pageIntegerIndica la página a obtener resultados.
per_pageIntegerCantidad de resultados por página (Máximo 40).
first_nameStringNombre del cliente
last_nameStringApellido del cliente
emailStringDirección de correo electrónico del cliente
external_idStringId externo cargado para el cliente
tax_idStringNúmero de identificación tributaria del cliente

Success 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/account_id?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>

Headers

Content-Type: application/json
Authorization: Bearer <access_token>

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

Headers

Content-Type:application/json
Authorization: Bearer <access_token>

Response

{
"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"
}