Documentação

Contrato Registrado

Suggest Edits

Quando um contrato é registrado enviamos este evento onde temos as informações a respeito de quem realizou a operação, valores a serem pagos e as datas para os pagamentos.

Você pode utilizar os _links para navegar nos recursos relacionados a este evento.

Path: /contract

Webhook payload object

ChaveTipoDescrição

contractId


string

Identificador do contrato.

orderBuyerId


string

Identificador de correlação do contrato.

status


string

Situação do contrato.

Valores possíveis são:
WAITING_CUSTODY - Aguardando custódia


contractType


string

Modalidade do contrato.

Valores possíveis são:
ORIGINAL - Antecipação pontual
RECOMPOSITION - Antecipação de recomposição de diluição
AUTOMATED - Antecipação de antecipação automática


contractStartDate


long

Data de início do contrato.

contractDueDate


long

Data de vencimento do contrato.

averageTax


number

Taxa média do contrato.

buyerGovernmentId


string

CNPJ ou CPF do investidor.

buyerName


string

Razão Social ou Nome do investidor.

sellerName


string

Razão Social ou Nome do cedente.

sellerGovernmentId


string

CNPJ ou CPF do cedente.

sellerAddress


string

Endereço do cedente.

sellerAddressNumber


string

Número do endereço do cedente.

sellerAddressComplement


string

Complemento do endereço do cedente.

sellerNeighborhood


string

Bairro do cedente.

sellerCity


string

Cidade do cedente.

sellerState


string

Estado do cedente.

sellerCountry


string

País do cedente.

sellerZipCode


string

CEP do cedente.

sellerBank


string

Código do banco do cedente.

sellerAgency


string

Código da agência bancária do cedente.

sellerAccount


string

Conta corrente do cedente (Sem o dígito).

sellerAccountDigit


string

Dígito da conta corrente do cedente.

paymentDate


long

Data de pagamento do contrato.

totalAmount


number

Valor bruto total do contrato.

totalDiscount


number

Valor total do desconto do contrato.

netTotalAmount


number

Valor líquido total do contrato.

numberOfReceivables


integer

Quantidade Total de Recebíveis no Contrato.

items


array

Array contendo os itens desta compra.

items[][contractItemId]


string

Identificador do item do contrato.


items[][receivableUuid]


string

Identificador do recebível na plataforma.


items[][acquirerGovernmentId]


string

CNPJ da credenciadora ou subcredenciadora.


items[][paymentScheme]


string

Código identificador da bandeira.


items[][liquidationDate]


long

Data de liquidação do recebível.


items[][tax]


string

Taxa aplicada no recebível.


items[][amount]


number

Valor negociado do item do contrato.


items[][discount]


number

Valor de desconto no item do contrato.


items[][netAmount]


number

Valor líquido do item do contrato.


items[][status]


string

Situação do item do contrato.

Valores possíveis são:
WAITING_CUSTODY - Aguardando custódia


items[][effectPriority]


string

Ordem de prioridade no recebível negociado.


items[][originalContractId]


string

Para os casos de contrato do tipo recomposição, será enviado o identificador do contrato que está sendo recomposto por este.


items[][originalContractItemId]


string

Para os casos de contrato do tipo recomposição, será enviado o identificador do item de contrato que está sendo recomposto por este.


externalId


string

Identificador do contrato na registradora.

registerGovernmentId


string

CNPJ da entidade registradora.

registerName


string

Nome da entidade registradora.

_links


object

Recursos disponíveis através de HATEOAS.
Para saber mais clique aqui.

Recursos disponíveis são:
seller - Listar dados do cedente.
confirm - Confirmar contrato.
unconfirm - Recusar contrato.
contract - Listar este contrato.

Webhook payload example

Exemplo de payload de contrato ORIGINAL, verificar campo contractType.

{
  "contractId" : "45bfe258-9bd1-11ec-b909-0242ac120002",
  "orderBuyerId":"39ddab57-0b5d-4286-b882-e065edb91071",
  "status" : "WAITING_CUSTODY",
  "contractType" : "ORIGINAL",
  "contractStartDate" : "2022-02-07T01:00:00.000-02:00",
  "contractDueDate" : "2022-02-25T00:00:00.000-03:00",
  "averageTax" : 1.00,
  "buyerGovernmentId" : "25297658000138",
  "buyerName" : "Investidor",
  "sellerName" : "Cedente",
  "sellerGovernmentId" : "78795395000153",
  "sellerAddress" : "Endereço",
  "sellerAddressNumber" : "1234",
  "sellerAddressComplement" : "Bloco Dois",
  "sellerNeighborhood" : "Bairro",
  "sellerCity" : "Cidade",
  "sellerState" : "UF",
  "sellerCountry" : "Brasil",
  "sellerZipCode" : "15800000",
  "sellerBank" : "123",
  "sellerAgency" : "1234",
  "sellerAccount" : "0000000000000012345",
  "sellerAccountDigit" : "1",
  "sellerAccountType" : "CHECKING_ACCOUNT",
  "paymentDate" : "2022-02-03T01:00:00.000-02:00",
  "totalAmount" : "1000.00",
  "totalDiscount" : "100.00",
  "netTotalAmount" : "900.00",
  "numberOfReceivables" : 2,
  "items" : [
    {
      "contractItemId" : "759818d6-9bd8-11ec-b909-0242ac120002",
      "receivableUuid" : "7bb3b3e2-9bd8-11ec-b909-0242ac120002",
      "acquirerGovernmentId" : "01027058000191",
      "paymentScheme" : "MCC",
      "liquidationDate" : "2022-02-22T00:00:00.000-03:00",
      "tax" : 1.00,
      "amount" : "500.00",
      "discount" : "50.00",
      "netAmount" : "450.00",
      "status" : "WAITING_CUSTODY",
      "effectPriority" : 1
    },
    {
      "contractItemId" : "81448480-9bd8-11ec-b909-0242ac120002",
      "receivableUuid" : "87515420-9bd8-11ec-b909-0242ac120002",
      "acquirerGovernmentId" : "10440482000154",
      "paymentScheme" : "VCC",
      "liquidationDate" : "2022-02-07T01:00:00.000-02:00",
      "tax" : 1.00,
      "amount" : "500.00",
      "discount" : "50.00",
      "netAmount" : "450.00",
      "status" : "WAITING_CUSTODY",
      "effectPriority" : 2
    }
  ],
  "externalId" : "56bfe259-0bd1-11ec-b019-0242ac120002",
  "registerGovernmentId" : "84361075000198",
  "registerName" : "REGISTRADORA",
  "eventType" : "ContractRegisteredEvent",
  "_links" : {
    "seller" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/sellers/05138015000134",
      "type" : "GET"
    },
    "confirm" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002/confirm",
      "type" : "GET"
    },
    "contract" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002",
      "type" : "GET"
    },
    "unconfirm" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002/unconfirm",
      "type" : "GET"
    }
  }
}

Exemplo de payload de contrato RECOMPOSITION, verificar campo contractType.

{
  "contractId" : "45bfe258-9bd1-11ec-b909-0242ac120002",
  "orderBuyerId":"39ddab57-0b5d-4286-b882-e065edb91071",
  "status" : "WAITING_CUSTODY",
  "contractType" : "RECOMPOSITION",
  "contractStartDate" : "2022-02-07T01:00:00.000-02:00",
  "contractDueDate" : "2022-02-25T00:00:00.000-03:00",
  "averageTax" : 1.00,
  "buyerGovernmentId" : "25297658000138",
  "buyerName" : "Investidor",
  "sellerName" : "Cedente",
  "sellerGovernmentId" : "78795395000153",
  "sellerAddress" : "Endereço",
  "sellerAddressNumber" : "1234",
  "sellerAddressComplement" : "Bloco Dois",
  "sellerNeighborhood" : "Bairro",
  "sellerCity" : "Cidade",
  "sellerState" : "UF",
  "sellerCountry" : "Brasil",
  "sellerZipCode" : "15800000",
  "sellerBank" : "123",
  "sellerAgency" : "1234",
  "sellerAccount" : "0000000000000012345",
  "sellerAccountDigit" : "1",
  "sellerAccountType" : "CHECKING_ACCOUNT",
  "paymentDate" : "2022-02-03T01:00:00.000-02:00",
  "totalAmount" : "1000.00",
  "totalDiscount" : "100.00",
  "netTotalAmount" : "900.00",
  "numberOfReceivables" : 2,
  "items" : [
    {
      "contractItemId" : "759818d6-9bd8-11ec-b909-0242ac120002",
      "receivableUuid" : "7bb3b3e2-9bd8-11ec-b909-0242ac120002",
      "acquirerGovernmentId" : "01027058000191",
      "paymentScheme" : "MCC",
      "liquidationDate" : "2022-02-22T00:00:00.000-03:00",
      "tax" : 1.00,
      "amount" : "500.00",
      "discount" : "50.00",
      "netAmount" : "450.00",
      "status" : "WAITING_CUSTODY",
      "effectPriority" : 1,
      "originalContractId" : "7bb3b3e2-9bd8-11ec-b909-0242ac121235",
      "originalContractItemId" : "8bb3b3e2-9bd8-11ec-b909-0242ac123232"
    },
    {
      "contractItemId" : "81448480-9bd8-11ec-b909-0242ac120002",
      "receivableUuid" : "87515420-9bd8-11ec-b909-0242ac120002",
      "acquirerGovernmentId" : "10440482000154",
      "paymentScheme" : "VCC",
      "liquidationDate" : "2022-02-07T01:00:00.000-02:00",
      "tax" : 1.00,
      "amount" : "500.00",
      "discount" : "50.00",
      "netAmount" : "450.00",
      "status" : "WAITING_CUSTODY",
      "effectPriority": 3,
      "originalContractId" : "9db3b3e2-9bd8-11ec-b909-0242ac121235",
      "originalContractItemId" : "0cb3b3e2-9bd8-11ec-b909-0242ac123232"
    }
  ],
  "externalId" : "56bfe259-0bd1-11ec-b019-0242ac120002",
  "registerGovernmentId" : "84361075000198",
  "registerName" : "REGISTRADORA",
  "eventType" : "ContractRegisteredEvent",
  "_links" : {
    "seller" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/sellers/05138015000134",
      "type" : "GET"
    },
    "confirm" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002/confirm",
      "type" : "GET"
    },
    "contract" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002",
      "type" : "GET"
    },
    "unconfirm" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002/unconfirm",
      "type" : "GET"
    }
  }
}

Exemplo de payload de contrato AUTOMATED, verificar campo contractType.

{
  "contractId" : "45bfe258-9bd1-11ec-b909-0242ac120002",
  "orderBuyerId":"39ddab57-0b5d-4286-b882-e065edb91071",
  "status" : "WAITING_CUSTODY",
  "contractType" : "AUTOMATED",
  "contractStartDate" : "2022-02-07T01:00:00.000-02:00",
  "contractDueDate" : "2022-02-25T00:00:00.000-03:00",
  "averageTax" : 1.00,
  "buyerGovernmentId" : "25297658000138",
  "buyerName" : "Investidor",
  "sellerName" : "Cedente",
  "sellerGovernmentId" : "78795395000153",
  "sellerAddress" : "Endereço",
  "sellerAddressNumber" : "1234",
  "sellerAddressComplement" : "Bloco Dois",
  "sellerNeighborhood" : "Bairro",
  "sellerCity" : "Cidade",
  "sellerState" : "UF",
  "sellerCountry" : "Brasil",
  "sellerZipCode" : "15800000",
  "sellerBank" : "123",
  "sellerAgency" : "1234",
  "sellerAccount" : "0000000000000012345",
  "sellerAccountDigit" : "1",
  "sellerAccountType" : "CHECKING_ACCOUNT",
  "paymentDate" : "2022-02-03T01:00:00.000-02:00",
  "totalAmount" : "1000.00",
  "totalDiscount" : "100.00",
  "netTotalAmount" : "900.00",
  "numberOfReceivables" : 2,
  "items" : [
    {
      "contractItemId" : "759818d6-9bd8-11ec-b909-0242ac120002",
      "receivableUuid" : "7bb3b3e2-9bd8-11ec-b909-0242ac120002",
      "acquirerGovernmentId" : "01027058000191",
      "paymentScheme" : "MCC",
      "liquidationDate" : "2022-02-22T00:00:00.000-03:00",
      "tax" : 1.00,
      "amount" : "500.00",
      "discount" : "50.00",
      "netAmount" : "450.00",
      "status" : "WAITING_CUSTODY",
      "effectPriority" : 1,
      "originalContractId" : "7bb3b3e2-9bd8-11ec-b909-0242ac121235",
      "originalContractItemId" : "8bb3b3e2-9bd8-11ec-b909-0242ac123232"
    },
    {
      "contractItemId" : "81448480-9bd8-11ec-b909-0242ac120002",
      "receivableUuid" : "87515420-9bd8-11ec-b909-0242ac120002",
      "acquirerGovernmentId" : "10440482000154",
      "paymentScheme" : "VCC",
      "liquidationDate" : "2022-02-07T01:00:00.000-02:00",
      "tax" : 1.00,
      "amount" : "500.00",
      "discount" : "50.00",
      "netAmount" : "450.00",
      "status" : "WAITING_CUSTODY",
      "effectPriority": 3,
      "originalContractId" : "9db3b3e2-9bd8-11ec-b909-0242ac121235",
      "originalContractItemId" : "0cb3b3e2-9bd8-11ec-b909-0242ac123232"
    }
  ],
  "externalId" : "56bfe259-0bd1-11ec-b019-0242ac120002",
  "registerGovernmentId" : "84361075000198",
  "registerName" : "REGISTRADORA",
  "eventType" : "ContractRegisteredEvent",
  "_links" : {
    "seller" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/sellers/05138015000134",
      "type" : "GET"
    },
    "confirm" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002/confirm",
      "type" : "GET"
    },
    "contract" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002",
      "type" : "GET"
    },
    "unconfirm" : {
      "href" : "https://gateway.spike.cash/v1/buyers/25297658000138/contracts/45bfe258-9bd1-11ec-b909-0242ac120002/unconfirm",
      "type" : "GET"
    }
  }
}

Updated over 1 year ago