Triggers

Um Trigger é utilizado para criar alguns fluxos automatizados. Ele é composto de uma condição e um tipo, isto é, sempre que aquela condição ocorrer, execute um Trigger deste tipo.

Atualmente, são suportados as seguintes condições:

  • Ledger_Transfer : Uma Transferência foi realizada para sua Conta ou uma Conta filha.

E os seguintes tipos:

  • WebHook: Ser notificado em uma url.

Dessa forma, pode-se criar uma automatização para ser notificado em um url sempre que ocorrer uma Transferência para sua Conta ou uma Conta filha.

É possível criar qualquer combinação de condição e tipo.

Condições

Ledger_Transfer

Repassa todos os dados sobre a transferência da seguinte forma:

{
"action": {
"type": "TRANSFER"
"from": "<ID da Conta remetente>",
"to": "<ID da Conta destinatário>",
"amount": "<Valor transferido>",
"assetId": "<ID do Ativo>",
},
"batchFields: {} // campo `fields` do Lote que executou esta Ação
}

Tipos

WebHook

Por motivos de segurança, o seu endpoint deve somente aceitar requisições seguras e seguir o modelo de autenticação utilizado na API da Swipe.

Recebe uma url que será notificada sempre que a condição escolhida ocorrer.

Consideramos que chamada foi bem sucedida se ela retornar um status 2xx. Caso a resposta seja diferente, consideramos que houve um erro e faremos mais duas tentativas.

A chamada possui as seguintes características:

post

https://<url passada na criação do Trigger>
Request
Response
Request
Headers
x-swp-timestamp
required
string
Unix time da assinatura desta requisição
x-api-key
required
string
Sua apiKey
x-swp-signature
required
string
Assinatura da requisição
Body Parameters
batchFields
optional
object
`fields` do Lote que executou esta Ação
action
required
object
Dados sobre a Ação
action.amount
required
string
Valor da transferência
action.assetId
required
string
ID do Ativo
action.to
required
string
ID da Conta remetente
action.from
required
string
ID da Conta destinatário
action.type
required
string
campo com valor `TRANSFER`
Response
200: OK