Docs
App Afiliados
API
post https://api.affiliates.iugu.com/events

Cria novos eventos

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Schema Obrigatório

Tipo de conteúdo: application/json
events
Array of objects

affiliate_id

Obrigatório

String

ID do afiliado responsável pelo evento

Ex: 7iCCaotmWlRFig39trAXkB
event

Obrigatório

String

Nome da ação ou transação realizada

Ex: Boleto
amount

Obrigatório

Number

Valor total da operação

Ex: 100.0
idempotency_key

Obrigatório

String

Chave de idepotência

Ex: 23231233
Exemplo 
1
2
3
4
5
6
7
8
9
10

{
  "events": [
    {
      "affiliate_id": "7iCCaotmWlRFig39trAXkB",
      "event": "Boleto",
      "amount": 100.0,
      "idempotency_key": 23231233
    }
  ]
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
Criação bem-sucedida
created
Number

Número de eventos criados

Ex: 12
errors
Array of objects

event
Object

affiliate_id
String

ID do afiliado responsável pelo evento

Ex: 7iCCaotmWlRFig39trAXkB
event
String

Nome da ação ou transação realizada

Ex: Boleto
amount
Number

Valor total da operação

Ex: 100.0
position
Number

Posição do evento na lista enviada

Ex: 1
message
String

Mensagem de erro

Ex: Validation error: The property '#/idempotency_key' of type null did not match the following type: string
422
Unprocessable Entity
created
Number

Número de eventos criados

Ex: 0
errors
Array of objects

event
Object

affiliate_id
String

ID do afiliado responsável pelo evento

Ex: 7iCCaotmWlRFig39trAXkB
event
String

Nome da ação ou transação realizada

Ex: Boleto
amount
Number

Valor total da operação

Ex: 100.0
position
Number

Posição do evento na lista enviada

Ex: 1
message
String

Mensagem de erro

Ex: Validation error: The property '#/idempotency_key' of type null did not match the following type: string
500
Internal Server Error
errors
String

Mensagem de erro

Ex: Internal Server Error

Voltar

Retorna uma lista de eventos

Avançar

Retorna uma lista de pagamentos