Search docs/

Prover cobranças

{...}

O Hub de API's no Layers permite que apps troquem informações por meio de actions: protocolos especificando o formato de requisição e resposta aceitos para uma determinada informação. Apps que provém informações de cobranças por meio da action @layers:payments:Payables:getRelated receberão a requisição no formato abaixo e devem respondê-la com todos os campos obrigatórios.

POST https://api.provedor-registrado.com/v1/@layers:payments:Payables:getRelated
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2020-09-15T14:14:14.277Z",
    "action": "@layers:identificador_da_action",
    "community": "test"
  },
  "secret": "exemplo",
  "data": {
    "user": {
      "id": "5bb2575199d7179dfe85be02",
      "name": "João Pedro",
      "alias": "0001",
      "timezone": "America/Sao_Paulo",
      "language": "pt/BR",
      "accountId": "5bb2575199d7179dfe85be02"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • resultObject[ ]obrigatório

Exemplo

{
  "result": [
    {
      "id": "0001",
      "title": "Marco Aurélio",
      "description": "Responsável financeiro",
      "installments": 12,
      "customer": {
        "document": {
          "kind": "cpf",
          "value": "111.111.111-11"
        },
        "name": "Felipe Layers",
        "email": "email@layers.education",
        "phone": "(11)99999-9999",
        "birth": "2020-09-15"
      },
      "payables": [
        {
          "id": "0002",
          "alias": "3213",
          "installment": 1,
          "description": "Mensalidade referente ao mês de Janeiro de 2020",
          "status": "pending",
          "dueAt": "2020-09-15",
          "paidAt": "2020-09-15",
          "sentAt": "2020-09-15",
          "centsPaid": 5.5,
          "centsTotal": 150000,
          "centsOriginal": 150000,
          "boleto": {
            "link": "https://boleto.pdf",
            "code": "12341234123412341234"
          },
          "attachments": [
            {
              "kind": "file",
              "title": "Comprovante de estorno",
              "description": "Estorno realizado em 31/10/2019",
              "url": "https://url.para-download.com"
            }
          ]
        }
      ]
    }
  ]
}
CopiarCopiado