https://gateway.iugu.com/api/v1/transactions/charge
Autorizar e capturar em uma única requisição
Realiza autorização e captura em uma única etapa. Aceita o mesmo corpo de /authorize e segue as mesmas regras de idempotência por order_id e de recusa do adquirente (200 com payment.status nulo).
Sem ações implementadas definidas
Request
|
Headers |
|
|---|---|
|
Workspace-Id
Type: string ID do workspace. Quando ausente, é usado o workspace padrão do Gateway. Ex: 1D81KhKbYuVq9505Bz4Nk9 |
|
|
Body Required Content Type: application/json |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
{
"account_id": "<ACCOUNT_ID>",
"order_id": "<ORDER_ID>",
"client_ref": "<CLIENT_REF>",
"credit_card_id": "<CREDIT_CARD_ID>",
"mcc": "<MCC>",
"cnpj": "<CNPJ>",
"amount_cents": "<AMOUNT_CENTS>",
"installments": "<INSTALLMENTS>",
"soft_descriptor": "<SOFT_DESCRIPTOR>",
"account_info": {
},
"payment_receipt": "<PAYMENT_RECEIPT>",
"initiator": "<INITIATOR>",
"subscription_id": "<SUBSCRIPTION_ID>",
"currency": "<CURRENCY>",
"extra_amount_cents": "<EXTRA_AMOUNT_CENTS>",
"fines_cents": "<FINES_CENTS>",
"discount_cents": "<DISCOUNT_CENTS>",
"recurrent": "<RECURRENT>",
"ip_address": "<IP_ADDRESS>",
"skip_anti_fraud": "<SKIP_ANTI_FRAUD>",
"network_tid": "<NETWORK_TID>",
"transaction_link_id": "<TRANSACTION_LINK_ID>",
"site": "<SITE>",
"sub_merchant": {
"id": "<ID>",
"document_type": "<DOCUMENT_TYPE>",
"document_number": "<DOCUMENT_NUMBER>",
"address": "<ADDRESS>",
"city": "<CITY>",
"state": "<STATE>",
"country_code": "<COUNTRY_CODE>",
"postal_code": "<POSTAL_CODE>",
"mcc": "<MCC>",
"company_name": "<COMPANY_NAME>",
"phone_number": "<PHONE_NUMBER>",
"website": "<WEBSITE>"
},
"items": [
{
"name": "<NAME>",
"type": "<TYPE>",
"price_cents": "<PRICE_CENTS>",
"description": "<DESCRIPTION>",
"quantity": "<QUANTITY>"
}
],
"payer": {
"email": "<EMAIL>",
"id": "<ID>",
"name": "<NAME>",
"document_number": "<DOCUMENT_NUMBER>",
"phone_prefix": "<PHONE_PREFIX>",
"phone_number": "<PHONE_NUMBER>",
"gender": "<GENDER>",
"borned_at": "<BORNED_AT>",
"created_at": "<CREATED_AT>",
"address": {
"street": "<STREET>",
"number": "<NUMBER>",
"district": "<DISTRICT>",
"city": "<CITY>",
"state": "<STATE>",
"country": "<COUNTRY>",
"postal_code": "<POSTAL_CODE>"
}
},
"receiver": {
"name": "<NAME>",
"document_number": "<DOCUMENT_NUMBER>",
"postal_code": "<POSTAL_CODE>"
},
"subscription": {
"id": "<ID>",
"price_cents": "<PRICE_CENTS>",
"recurrence": "<RECURRENCE>",
"started_at": "<STARTED_AT>",
"expires_at": "<EXPIRES_AT>"
}
}
Response
|
200 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Pagamento processado (cobrado ou recusado pelo adquirente)
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
{
"payment": {
"id": "<ID>",
"status": "<STATUS>",
"multi": [
"<MULTI>"
],
"success_ec": "<SUCCESS_EC>",
"mcc": "<MCC>",
"recurrent": "<RECURRENT>",
"card_on_file": "<CARD_ON_FILE>",
"tid": "<TID>",
"nsu": "<NSU>",
"authorization_code": "<AUTHORIZATION_CODE>",
"amount_cents": "<AMOUNT_CENTS>",
"refunded_amount_cents": "<REFUNDED_AMOUNT_CENTS>",
"cnpj": "<CNPJ>",
"workspace_id": "<WORKSPACE_ID>",
"account_id": "<ACCOUNT_ID>",
"invoice_id": "<INVOICE_ID>",
"client_ref": "<CLIENT_REF>",
"subscription_id": "<SUBSCRIPTION_ID>",
"card_id": "<CARD_ID>",
"card_bin": "<CARD_BIN>",
"card_last_four": "<CARD_LAST_FOUR>",
"currency": "<CURRENCY>",
"installments": "<INSTALLMENTS>",
"soft_descriptor": "<SOFT_DESCRIPTOR>",
"created_at": "<CREATED_AT>",
"updated_at": "<UPDATED_AT>",
"transactions": [
{
"id": "<ID>",
"function": "<FUNCTION>",
"success": "<SUCCESS>",
"tid": "<TID>",
"nsu": "<NSU>",
"arp": "<ARP>",
"acquirer": {
"payment_id": "<PAYMENT_ID>",
"status_code": "<STATUS_CODE>",
"acquirer_mac_code": "<ACQUIRER_MAC_CODE>",
"status_description": "<STATUS_DESCRIPTION>",
"request_status_code": "<REQUEST_STATUS_CODE>",
"request_status_description": "<REQUEST_STATUS_DESCRIPTION>"
},
"lr": {
"code": "<CODE>",
"source": "<SOURCE>"
},
"card_id": "<CARD_ID>",
"card_bin": "<CARD_BIN>",
"card_last_four": "<CARD_LAST_FOUR>",
"card_on_file": "<CARD_ON_FILE>",
"transaction_token_type": "<TRANSACTION_TOKEN_TYPE>",
"amount_cents": "<AMOUNT_CENTS>",
"ec_group": {
"id": "<ID>",
"name": "<NAME>"
},
"commercial_enterprise": {
"id": "<ID>",
"name": "<NAME>",
"number": "<NUMBER>",
"acquirer": "<ACQUIRER>",
"mcc": {
"id": "<ID>",
"code": "<CODE>",
"description": "<DESCRIPTION>"
}
},
"created_at": "<CREATED_AT>"
}
],
"anti_fraud": [
{
"id": "<ID>",
"payment_id": "<PAYMENT_ID>",
"provider": "feedzai",
"provider_id": "<PROVIDER_ID>",
"decision": "<DECISION>",
"omniscore": "<OMNISCORE>",
"created_at": "<CREATED_AT>"
}
]
}
}
|
400 |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Parâmetro obrigatório ausente, com tipo/formato inválido ou não documentado
|
||||||||||
1
2
3
4
5
6
7
{
"error": "<ERROR>",
"error_code": "invalid_sub_merchant_postal_code",
"details": {
"message": "sub_merchant.postal_code format is invalid"
}
}
|
401 |
||
|---|---|---|
|
Não autorizado - Token de autenticação inválido ou ausente
|
||
1
2
3
{
"message": "<MESSAGE>"
}
|
403 |
||||||||
|---|---|---|---|---|---|---|---|---|
|
`anti_fraud_unauthorized`: a análise antifraude recusou a transação (`details` traz o registro da análise)
|
||||||||
1
2
3
4
5
6
{
"error": "payment_not_found",
"service": "Acquirers::CancelService",
"details": {
}
}
|
404 |
||||||||
|---|---|---|---|---|---|---|---|---|
|
`credit_card_not_found`: Cartão de crédito não encontrado
|
||||||||
1
2
3
4
5
6
{
"error": "payment_not_found",
"service": "Acquirers::CancelService",
"details": {
}
}
|
409 |
||||||||
|---|---|---|---|---|---|---|---|---|
|
`payment_processing_in_progress`: outra requisição para o mesmo pagamento está em processamento; tente novamente
|
||||||||
1
2
3
4
5
6
{
"error": "payment_not_found",
"service": "Acquirers::CancelService",
"details": {
}
}
|
422 |
||||||||
|---|---|---|---|---|---|---|---|---|
|
Requisição não processável. Possíveis causas: - `token_blocked`: o token do cartão está bloqueado por recusas anteriores - `mcc_mismatch`: o MCC informado diverge do MCC do CNPJ (quando o workspace está configurado para bloquear) - `no_active_mcc_found`: nenhum MCC ativo encontrado para o CNPJ - `serpro_unavailable`: consulta de dados do CNPJ indisponível - `payment_creation_error`: falha ao registrar o pagamento
|
||||||||
1
2
3
4
5
6
{
"error": "payment_not_found",
"service": "Acquirers::CancelService",
"details": {
}
}
|
500 |
||||||||
|---|---|---|---|---|---|---|---|---|
|
Erro interno. Inclui falhas de roteamento (ex.: `no_ec_group_found`, `no_active_ecs_available`) e erros inesperados.
|
||||||||
1
2
3
4
5
6
{
"error": "payment_not_found",
"service": "Acquirers::CancelService",
"details": {
}
}