/
transfer.go
391 lines (374 loc) · 14.1 KB
/
transfer.go
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
package asaas
import (
"context"
"fmt"
"net/http"
)
type TransferToBankRequest struct {
// Valor a ser transferido (REQUIRED)
Value float64 `json:"value,omitempty"`
// Informe os dados da conta caso seja uma transferência para conta bancária (REQUIRED)
BankAccount BackAccountRequest `json:"bankAccount,omitempty"`
// Modalidade da transferência. Caso não informado e a instituição recebedora seja participante do pix, a transferência é via pix. Do contrário via TED.
OperationType TransferOperationType `json:"operationType,omitempty"`
// Informe a chave pix caso seja uma transferência TransferOperationTypePix
PixAddressKey string `json:"pixAddressKey,omitempty"`
// Informe o tipo de chave caso seja uma transferência TransferOperationTypePix
PixAddressKeyType PixKeyType `json:"pixAddressKeyType,omitempty"`
// Transferência TransferOperationTypePix permitem descrição
Description string `json:"description,omitempty"`
// Para transferências agendadas, caso não informado o pagamento é instantâneo
ScheduleDate Date `json:"scheduleDate,omitempty"`
}
type TransferToAssasRequest struct {
// Valor a ser transferido (REQUIRED)
Value float64 `json:"value,omitempty"`
// WalletId da conta de destino
WalletId string `json:"walletId,omitempty"`
}
type BackAccountRequest struct {
// Informações da instituição bancária
Bank BankRequest `json:"bank,omitempty"`
// Nome da conta bancária
AccountName string `json:"accountName,omitempty"`
// Nome do proprietário da conta bancária (REQUIRED)
OwnerName string `json:"ownerName,omitempty"`
// Data de nascimento do proprietário da conta. Somente quando a conta bancária não pertencer ao mesmo CPF ou CNPJ da conta Asaas.
OwnerBirthDate Date `json:"ownerBirthDate,omitempty"`
// CPF ou CNPJ do proprietário da conta bancária (REQUIRED)
CpfCnpj string `json:"cpfCnpj,omitempty"`
// Número da agência sem dígito (REQUIRED)
Agency string `json:"agency,omitempty"`
// Número da conta bancária sem dígito (REQUIRED
Account string `json:"account,omitempty"`
// Dígito da conta bancária (REQUIRED
AccountDigit string `json:"accountDigit,omitempty"`
// Tipo da conta (REQUIRED)
BankAccountType BankAccountType `json:"bankAccountType,omitempty"`
// Identificador no Sistema de Pagamentos Brasileiro
Ispb string `json:"ispb,omitempty"`
}
type BankRequest struct {
// Código de compensação do banco no sistema bancário (REQUIRED)
Code string `json:"code,omitempty"`
}
type GetAllTransfersRequest struct {
// Filtrar pela data de criação inicial
DateCreatedGe Date `json:"dateCreated[ge],omitempty"`
// Filtrar pela data de criação final
DateCreatedLe Date `json:"dateCreated[le],omitempty"`
// Filtrar pela data inicial de efetivação de transferência
TransferDateGe Date `json:"transferDate[ge],omitempty"`
// Filtrar pela data final de efetivação de transferência
TransferDateLe Date `json:"transferDate[le],omitempty"`
// Filtrar por tipo da transferência
Type TransferType `json:"type,omitempty"`
}
type TransferResponse struct {
Id string `json:"id,omitempty"`
Type TransferType `json:"type,omitempty"`
Status TransferStatus `json:"status,omitempty"`
Value float64 `json:"value,omitempty"`
NetValue float64 `json:"netValue,omitempty"`
TransferFee float64 `json:"transferFee,omitempty"`
EffectiveDate Date `json:"effectiveDate,omitempty"`
EndToEndIdentifier string `json:"endToEndIdentifier,omitempty"`
ScheduleDate Date `json:"scheduleDate,omitempty"`
Authorized bool `json:"authorized,omitempty"`
FailReason string `json:"failReason,omitempty"`
WalletId string `json:"walletId,omitempty"`
BackAccount *BackAccountResponse `json:"backAccount,omitempty"`
TransactionReceiptUrl string `json:"transactionReceiptUrl,omitempty"`
OperationType TransferOperationType `json:"operationType,omitempty"`
Description string `json:"description,omitempty"`
Errors []ErrorResponse `json:"errors,omitempty"`
DateCreated Date `json:"dateCreated,omitempty"`
}
type BackAccountResponse struct {
Bank BankResponse `json:"bank,omitempty"`
AccountName string `json:"accountName,omitempty"`
OwnerName string `json:"ownerName,omitempty"`
OwnerBirthDate Date `json:"ownerBirthDate,omitempty"`
CpfCnpj string `json:"cpfCnpj,omitempty"`
Agency string `json:"agency,omitempty"`
Account string `json:"account,omitempty"`
AccountDigit string `json:"accountDigit,omitempty"`
PixAddressKey string `json:"pixAddressKey,omitempty"`
}
type BankResponse struct {
Ispb string `json:"ispb,omitempty"`
Code string `json:"code,omitempty"`
Name string `json:"name,omitempty"`
}
type transfer struct {
env Env
accessToken string
}
type Transfer interface {
// TransferToBank (Transferir para conta de outra Instituição ou chave pix)
//
// Com este endpoint você pode fazer uma transferência para conta bancária ou chave pix.
//
// # Resposta: 200
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsSuccess() = true
//
// Possui os valores de resposta de sucesso segunda a documentação.
//
// # Resposta: 400/401/500
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsFailure() = true
//
// Para qualquer outra resposta inesperada da API, possuímos o campo TransferResponse.Errors preenchido com as informações
// de erro, sendo 400 retornado da API Asaas com as instruções de requisição conforme a documentação,
// diferente disso retornará uma mensagem padrão no index 0 do slice com campo ErrorResponse.Code retornando a
// descrição status http (Ex: "401 Unauthorized") e no campo ErrorResponse.Description retornará com o valor
// "response status code not expected".
//
// # Error
//
// TransferResponse = nil
//
// error = not nil
//
// Se o parâmetro de retorno error não estiver nil quer dizer que ocorreu um erro inesperado
// na lib go-asaas.
//
// Se isso acontecer por favor report o erro no repositório: https://github.com/GabrielHCataldo/go-asaas
//
// # DOCS
//
// Transferir para conta de outra Instituição ou chave pix: https://docs.asaas.com/reference/transferir-para-conta-de-outra-instituicao-ou-chave-pix
TransferToBank(ctx context.Context, body TransferToBankRequest) (*TransferResponse, error)
// TransferToAsaas (Transferir para conta Asaas)
//
// Só é possível fazer transferência entre contas Asaas para contas que possuam vínculo entre si,
// como conta-pai e conta-filha, ou duas contas-filhas de mesma conta-pai.
//
// # Resposta: 200
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsSuccess() = true
//
// Possui os valores de resposta de sucesso segunda a documentação.
//
// # Resposta: 400/401/500
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsFailure() = true
//
// Para qualquer outra resposta inesperada da API, possuímos o campo TransferResponse.Errors preenchido com as informações
// de erro, sendo 400 retornado da API Asaas com as instruções de requisição conforme a documentação,
// diferente disso retornará uma mensagem padrão no index 0 do slice com campo ErrorResponse.Code retornando a
// descrição status http (Ex: "401 Unauthorized") e no campo ErrorResponse.Description retornará com o valor
// "response status code not expected".
//
// # Error
//
// TransferResponse = nil
//
// error = not nil
//
// Se o parâmetro de retorno error não estiver nil quer dizer que ocorreu um erro inesperado
// na lib go-asaas.
//
// Se isso acontecer por favor report o erro no repositório: https://github.com/GabrielHCataldo/go-asaas
//
// # DOCS
//
// Transferir para conta Asaas: https://docs.asaas.com/reference/transferir-para-conta-asaas
TransferToAsaas(ctx context.Context, body TransferToAssasRequest) (*TransferResponse, error)
// CancelById (Cancelar uma transferência)
//
// # Resposta: 200
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsSuccess() = true
//
// Possui os valores de resposta de sucesso segunda a documentação.
//
// # Resposta: 404
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsNoContent() = true
//
// ID(s) informado no parâmetro não foi encontrado.
//
// # Resposta: 400/401/500
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsFailure() = true
//
// Para qualquer outra resposta inesperada da API, possuímos o campo TransferResponse.Errors preenchido com as informações
// de erro, sendo 400 retornado da API Asaas com as instruções de requisição conforme a documentação,
// diferente disso retornará uma mensagem padrão no index 0 do slice com campo ErrorResponse.Code retornando a
// descrição status http (Ex: "401 Unauthorized") e no campo ErrorResponse.Description retornará com o valor
// "response status code not expected".
//
// # Error
//
// TransferResponse = nil
//
// error = not nil
//
// Se o parâmetro de retorno error não estiver nil quer dizer que ocorreu um erro inesperado
// na lib go-asaas.
//
// Se isso acontecer por favor report o erro no repositório: https://github.com/GabrielHCataldo/go-asaas
//
// # DOCS
//
// Cancelar uma transferência: https://docs.asaas.com/reference/cancelar-uma-transferencia
CancelById(ctx context.Context, transferId string) (*TransferResponse, error)
// GetById (Recuperar uma única cobrança)
//
// Para recuperar uma transferência específica é necessário que você tenha o ID que o Asaas retornou no
// momento da sua criação.
//
// # Resposta: 200
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsSuccess() = true
//
// Possui os valores de resposta de sucesso segunda a documentação.
//
// # Resposta: 404
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsNoContent() = true
//
// ID(s) informado no parâmetro não foi encontrado.
//
// # Resposta: 401/500
//
// TransferResponse = not nil
//
// Error = nil
//
// TransferResponse.IsFailure() = true
//
// Para qualquer outra resposta inesperada da API, possuímos o campo TransferResponse.Errors preenchido com as informações
// de erro, o index 0 do slice com campo ErrorResponse.Code retornando a descrição
// status http (Ex: "401 Unauthorized") e no campo ErrorResponse.Description retornará com o valor
// "response status code not expected".
//
// # Error
//
// TransferResponse = nil
//
// error = not nil
//
// Se o parâmetro de retorno error não estiver nil quer dizer que ocorreu um erro inesperado
// na lib go-asaas.
//
// Se isso acontecer por favor report o erro no repositório: https://github.com/GabrielHCataldo/go-asaas
//
// # DOCS
//
// Recuperar uma única transferência: https://docs.asaas.com/reference/recuperar-uma-unica-transferencia
GetById(ctx context.Context, transferId string) (*TransferResponse, error)
// GetAll (Listar transferências)
//
// Este método retorna uma lista paginada com todas as transferências para o filtro informado.
//
// # Resposta: 200
//
// Pageable(TransferResponse) = not nil
//
// Error = nil
//
// Se Pageable.IsSuccess() for true quer dizer que retornaram os dados conforme a documentação.
// Se Pageable.IsNoContent() for true quer dizer que retornou os dados vazio.
//
// Error = nil
//
// Pageable.IsNoContent() = true
//
// Pageable.Data retornou vazio.
//
// # Resposta: 401/500
//
// Pageable(TransferResponse) = not nil
//
// Error = nil
//
// Pageable.IsFailure() = true
//
// Para qualquer outra resposta inesperada da API, possuímos o campo Pageable.Errors preenchido com
// as informações de erro, o index 0 do slice com campo ErrorResponse.Code retornando a descrição
// status http (Ex: "401 Unauthorized") e no campo ErrorResponse.Description retornará com o valor
// "response status code not expected".
//
// # Error
//
// Pageable(TransferResponse) = nil
//
// error = not nil
//
// Se o parâmetro de retorno error não estiver nil quer dizer que ocorreu um erro inesperado
// na lib go-asaas.
//
// Se isso acontecer por favor report o erro no repositório: https://github.com/GabrielHCataldo/go-asaas
//
// # DOCS
//
// Listar transferências: https://docs.asaas.com/reference/listar-transferencias
GetAll(ctx context.Context, filter GetAllTransfersRequest) (*Pageable[TransferResponse], error)
}
func NewTransfer(env Env, accessToken string) Transfer {
logWarning("Transfer service running on", env.String())
return transfer{
env: env,
accessToken: accessToken,
}
}
func (t transfer) TransferToBank(ctx context.Context, body TransferToBankRequest) (*TransferResponse, error) {
req := NewRequest[TransferResponse](ctx, t.env, t.accessToken)
return req.make(http.MethodPost, "/v3/transfers", body)
}
func (t transfer) TransferToAsaas(ctx context.Context, body TransferToAssasRequest) (*TransferResponse,
error) {
req := NewRequest[TransferResponse](ctx, t.env, t.accessToken)
return req.make(http.MethodPost, "/v3/transfers", body)
}
func (t transfer) CancelById(ctx context.Context, transferId string) (*TransferResponse, error) {
req := NewRequest[TransferResponse](ctx, t.env, t.accessToken)
return req.make(http.MethodDelete, fmt.Sprintf("/v3/transfers/%s/cancel", transferId), nil)
}
func (t transfer) GetById(ctx context.Context, transferId string) (*TransferResponse, error) {
req := NewRequest[TransferResponse](ctx, t.env, t.accessToken)
return req.make(http.MethodGet, fmt.Sprintf("/v3/transfers/%s", transferId), nil)
}
func (t transfer) GetAll(ctx context.Context, filter GetAllTransfersRequest) (*Pageable[TransferResponse], error) {
req := NewRequest[Pageable[TransferResponse]](ctx, t.env, t.accessToken)
return req.make(http.MethodGet, "/v3/transfers", filter)
}