Skip to main content

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ámetroTipoDescripciónRequerido
emailStringemail del clientesi
tax_idStringCUIT/CUIL/DNI o identificador del clientesi
billing_infoObjectDatos de Facturacion del Clientesi
first_nameStringNombre del clientesi
last_nameStringApellido del clientesi
external_idStringIdentificador del cliente en tu sistema.no
languageStringLenguaje del cliente por defectono
timezoneStringZona horaria del clienteno

Dentro del campo billing_info se podrá enviar

ParámetroTipoDescripciónRequerido
address_line_1StringLinea 1 direccion del clientesi
countryStringPais del Cliente (ARG, CHL, COL, ECU, PER, URY, PRY, BOL, CRI, PAN, MEX, SLV, DOM, BRA)si
cityStringCiudad del cLientesi
phoneStringTelefono del Clientesi
zip_codeStringCodigo Postal del clientesi
state_iso_codeStringProvincia del Cliente en formato ISOsolo para customers de Argentina. Default: AR-B
address_line_2StringLinea 2 direccion del clienteno
stateStringProvincia del Clienteno
Valores permitidos para state_iso_code son ISO 3166
ProvinciaCódigo ISO 3166
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

Ejemplo

{
"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"
}
}
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ámetroTipoDescripciónRequerido
pageIntegerIndica la página a obtener resultados.no
per_pageIntegerCantidad de resultados por página (Máximo 40).no
first_nameStringNombre del clienteno
last_nameStringApellido del clienteno
emailStringDirección de correo electrónico del clienteno
external_idStringId externo cargado para el clienteno
tax_idStringNúmero de identificación tributaria del clienteno

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
}