Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Company

CompanyContract Register

This API is responsible for registering new Contracts within the closed payment arrangement.

post/RegisterCompanyContractClosedLoop

Request body

Methodstring required

Text Containing The Name Of The Method

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

ArrangementIdentifierstring required

Arrangement Identifier

Namestring required

Name From Contract

NickNamestring

NickName From Contract

TaxNumberstring required

Legal Identification From Company

CompanySectorstring required

Sector From Contract's Company

ServiceTypeinteger required

Contract's Transactions Type

RatePurchaseValuenumber

Contract's Purchase Rate value

RatePurchaseTypeinteger

Contract's Purchase Rate Type (Percentage, Fixed)

RateWithdrawalValuenumber

Contract's Withdrawal Rate value

RateWithdrawalTypeinteger

Contract's Withdrawal Rate Type (Percentage, Fixed)

RateDepositValuenumber

Contract's Deposit Rate value

RateDepositTypeinteger

Contract's Deposit Rate Type (Percentage, Fixed)

DaysToSettleinteger required

Time span for the transactions settlement of the transactions

Example request

{
  "Method": "RegisterCompanyContractClosedLoop",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "ArrangementIdentifier": "ARR880ff122-e5a9-4069-aaac-d9e5f58dee8cARR",
  "Name": "Contract Name",
  "NickName": "Contract NickName",
  "TaxNumber": "33.762.255/0001-40",
  "CompanySector": "food",
  "ServiceType": 1,
  "RatePurchaseValue": 1.5,
  "RatePurchaseType": 1,
  "RateWithdrawalValue": 1.5,
  "RateWithdrawalType": 1,
  "RateDepositValue": 1.5,
  "RateDepositType": 1,
  "DaysToSettle": 2
}

Response

Register new contract

Successboolean

True or False

Messagestring

Returned message

CompanyContractClosedLoopIdinteger

Contract's Id number

ContractIdentifierstring

The Store's ContractIdentifier

Example response

{
  "Success": true,
  "Message": "Purchase generated successfully",
  "CompanyContractClosedLoopId": 4,
  "ContractIdentifier": "CON965569f9-5c93-4335-b09e-29efe32ba292CON"
}