API Multicaja PayPal (Alpha) API Reference

Bienvenido a la API de Multicaja PayPal (Alpha)

** Este es un proyecto alpha y por lo tanto sufrirá muchos cambios **

Todos los requests son autenticados usando un api-key.

API Endpoint
http://10.170.1.60:8000/paypal/1.0
Response Content-Types: application/json
Schemes: http
Version: 1.0

ping

Endpoint para verificar si la API-PayPal esta funcionando.

ping

GET /ping

Endpoint para verificar si la API-PayPal esta funcionando.

200 OK

OK

users

Obtener información de clientes de Multicaja/PayPal

users

GET /users/info

Obtiene la informacion de un usario en paypal

email: string
in query

Email del cliente de PayPal que se quiere consultar

200 OK

Respuesta correcta

type
object
404 Not Found

El email ingresado no fue encontrado en PayPal

type
object
422 Unprocessable Entity

El email ingresado es invalido o no fue ingresado

type
object
500 Internal Server Error

Ocurrió un error al consultar la API de PayPal

Response Example (200 OK) 
{
  "country": "CL",
  "account_id": "6FR8UB95HSZZU",
  "timestamp": "2018-05-14T14:34:07.824-07:00",
  "name": "Juan",
  "last_name": "Perez",
  "correlation_id": "2ef6d00c6b77c",
  "type": "PREMIER",
  "status": "UNVERIFIED/VERIFIED"
}
Response Example (404 Not Found) 
{
  "code": 200100,
  "message": "Email no encontrado en PayPal"
}
Response Example (422 Unprocessable Entity) 
{
  "code": 200101,
  "message": "El email ingresado es invalido"
}
Response Example (500 Internal Server Error) 
{
  "code": 200000,
  "message": "Ha ocurrido un error al obtener la información de PayPal"
}
users

GET /paypal/users/balance

Obtienen el balance de un un cliente en PayPal

type: string
in query

Tipo de transacción PayPal [ABONO/RETIRO/PIVOTE]

email: string
in query

Email del cliente de PayPal que se quiere consultar

200 OK

Respuesta correcta

404 Not Found

El email ingresado no fue encontrado en PayPal

422 Unprocessable Entity

Alguno de los parametros no fue ingresado o es invalido

500 Internal Server Error

Ocurrió un error al consultar la API de PayPal

Response Example (200 OK) 
{
  "correlation_id": "33308fedb33e3",
  "ack": "SUCCESS",
  "balance": {
    "value": 60,
    "currency_id": "USD"
  },
  "timestamp": "2018-05-14T14:34:07.824-07:00"
}
Response Example (404 Not Found) 
{
  "code": 200100,
  "message": "Email no encontrado en PayPal"
}
Response Example (422 Unprocessable Entity) 
{
  "code": 200101,
  "message": "El email ingresado es invalido"
}
Response Example (500 Internal Server Error) 
{
  "code": 200000,
  "message": "Ha ocurrido un error al obtener la información de PayPal"
}
Documentation by Spectacle