-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathapi-paypal.yml
More file actions
213 lines (204 loc) · 7.05 KB
/
Copy pathapi-paypal.yml
File metadata and controls
213 lines (204 loc) · 7.05 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
swagger: '2.0'
info:
title: API Multicaja PayPal (Alpha)
description: |
Bienvenido a la API de [Multicaja PayPal](https://www.multicaja.cl) (Alpha)
** Este es un proyecto alpha y por lo tanto sufrirá muchos cambios **
Todos los requests son autenticados usando un `api-key`.
version: '1.0'
produces:
- application/json
tags:
- name: ping
description: Endpoint para verificar si la API-PayPal esta funcionando.
- name: users
description: Obtener información de clientes de Multicaja/PayPal
paths:
/ping:
get:
tags:
- ping
description: Endpoint para verificar si la API-PayPal esta funcionando.
responses:
200:
description: OK
examples:
'0':
{"service":"PayPalResource10","implementation":{"class":"PayPalApiEJBBean10"}}
/users/info:
get:
tags:
- users
description: Obtiene la informacion de un usario en paypal
parameters:
- name: email
in: query
description: Email del cliente de PayPal que se quiere consultar
type: string
responses:
200:
description: Respuesta correcta
schema:
type: object
properties:
country:
type: string
description: País de origen de la cuenta PayPal
example: "CL"
account_id:
type: string
description: Id del cliente en paypal
example: "6FR8UB95HSZZU"
timestamp:
type: string
description: Fecha de la consulta PayPal
example: "2018-05-14T14:34:07.824-07:00"
name:
type: string
description: Nombre del cliente registrado en paypal
example: "Juan"
last_name:
type: string
description: Apellido del cliente registrado en paypal
example: "Perez"
correlation_id:
type: string
description: Identificador de la llamada a la API de PayPal
example: "2ef6d00c6b77c"
type:
type: string
description: Tipo de cliente registrado en paypal
example: "PREMIER"
status:
type: string
description: Estado del cliente en paypal
example: "UNVERIFIED/VERIFIED"
404:
description: El email ingresado no fue encontrado en PayPal
schema:
type: object
properties:
code:
type: integer
description: Codigo de error
example: 200100
message:
type: string
description: Mensaje de error
example: Email no encontrado en PayPal
422:
description: El email ingresado es invalido o no fue ingresado
schema:
type: object
properties:
code:
type: integer
description: Codigo de error
example: 200101
message:
type: string
description: Mensaje de error
example: El email ingresado es invalido
500:
description: Ocurrió un error al consultar la API de PayPal
schema:
properties:
code:
type: integer
description: Codigo de error
example: 200000
message:
type: string
description: Mensaje de error
example: Ha ocurrido un error al obtener la información de PayPal
/paypal/users/balance:
get:
tags:
- users
description: Obtienen el balance de un un cliente en PayPal
parameters:
- name: type
in: query
description: Tipo de transacción PayPal [ABONO/RETIRO/PIVOTE]
type: string
- name: email
in: query
type: string
description: Email del cliente de PayPal que se quiere consultar
responses:
200:
description: Respuesta correcta
schema:
properties:
correlation_id:
type: string
description: Identificador de la llamada a la API de PayPal
example: "33308fedb33e3"
ack:
type: string
description: Estado de respuesta de la API de PayPal
example: "SUCCESS"
balance:
type: object
description: Objeto que contiene el balance de la cuanta PayPal. Puede contener mas de una moneda por email
properties:
value:
type: string
description: Saldo de la cuenta
example: 60.00
currency_id:
type: string
description: Moneda del saldo
example: "USD"
timestamp:
type: string
description: Fecha de la consulta PayPal
example: "2018-05-14T14:34:07.824-07:00"
examples:
'0': {"last_name":"García","correlation_id":"7e332a1867d8","timestamp":"2018-06-27T09:55:46.098-07:00","name":"Ricardo","type":"PREMIER","country":"CL","status":"UNVERIFIED","account_id":"MCDYLVEEDQV34"}
404:
description: El email ingresado no fue encontrado en PayPal
schema:
properties:
code:
type: integer
description: Codigo de error
example: 200100
message:
type: string
description: Mensaje de error
example: Email no encontrado en PayPal
examples:
'0': '{"code":200100,"message":"Email no encontrado en PayPal"}'
422:
description: Alguno de los parametros no fue ingresado o es invalido
schema:
properties:
code:
type: integer
description: Codigo de error
example: 200101
message:
type: string
description: Mensaje de error
example: El email ingresado es invalido
examples:
'0': '{"code":200101,"message":"El email ingresado es invalido"}'
500:
description: Ocurrió un error al consultar la API de PayPal
schema:
properties:
code:
type: integer
description: Codigo de error
example: 200000
message:
type: string
description: Mensaje de error
example: Ha ocurrido un error al obtener la información de PayPal
examples:
'0': '{"code":200000,"message":"Ha ocurrido un error al obtener la información de PayPal"}'
host: 10.170.1.60:8000
basePath: /paypal/1.0
schemes:
- http