Skip to content
/AgreementService

Aurora API (v1.23.0-rc1)

Download OpenAPI description
connectapi.json
connectapi.yaml
Overview
URL
https://provablemarkets.com/contact
Provable Markets
info@provablemarkets.com
Terms of Service
Languages
Servers
Mock server
https://developer.provablemarkets.com/_mock/apis/connectapi
https://developer.provablemarkets.com

CompanyService

Methods to query companies

Operations

OmsEventsService

Operations

OmsService

Operations

ReportingService

Operations

ContractService

Operations

ContractEventsService

Operations

AgreementService

Operations

ApproveAgreement

Request

PATH: /aurora.core.apiengine.agreementsv1.AgreementService/ApproveAgreement

ApproveAgreement can be used to approve a drafted agreement

Security
Bearer
Bodyapplication/jsonrequired

Approve-Agreement Request

balance_targetstring

Balance Target can be added by each party for their own purposes, not visible to the counterparty

balance_target_variancestring

Balance Target Variance can be added by each party for their own purposes, not visible to the counterparty

booking_accountstring

Booking Account added by each party, visible to the counterparty

idstringrequired

ID of the agreement

profit_centerstring
settlement_systemstring(aurora.core.consts.agreements.SettlementSystem)
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
short_namestringrequired

Agreements require a short name that can be used for both display in the order book and when creating new orders. Short names must be unique amongst your agreements and must be 25 characters or less. Spaces are supported but not recommended.

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.agreementsv1.AgreementService/ApproveAgreement \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "balance_target": "string",
    "balance_target_variance": "string",
    "booking_account": "string",
    "id": "string",
    "profit_center": "string",
    "settlement_system": "SETTLEMENT_SYSTEM_UNSPECIFIED",
    "short_name": "string"
  }'

Responses

A successful response
Approve-Agreement Response

Bodyapplication/json
object(aurora.core.apiengine.agreementsv1.ApproveAgreementResponse)

Approve-Agreement Response

Response
application/json
{}

CancelAgreement

Request

PATH: /aurora.core.apiengine.agreementsv1.AgreementService/CancelAgreement

CancelAgreement can be used to cancel a drafted or active agreement

Security
Bearer
Bodyapplication/jsonrequired

Cancel-Agreement Request

idstringrequired

The reference for the agreement to be closed

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.agreementsv1.AgreementService/CancelAgreement \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string"
  }'

Responses

A successful response
Cancel-Agreement Response

Bodyapplication/json
object(aurora.core.apiengine.agreementsv1.CancelAgreementResponse)

Cancel-Agreement Response

Response
application/json
{}

CreateAgreement

Request

PATH: /aurora.core.apiengine.agreementsv1.AgreementService/CreateAgreement

CreateAgreement can be used tc create an agreement

Security
Bearer
Bodyapplication/jsonrequired

Create-Agreement Request

balance_targetstring

Balance Target can be added by each party for their own purposes, not visible to the counterparty

balance_target_variancestring

Balance Target Variance can be added by each party for their own purposes, not visible to the counterparty

billing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
booking_accountstring
collateral_currencystring(aurora.core.common.protos.Currency)
Enum"USD""CAD""GBP""EUR""JPY"
collateral_methodstring(aurora.core.consts.agreements.CollateralMethod)required
Enum"COLLATERAL_METHOD_UNSPECIFIED""PLEDGE""TITLE_TRANSFER"
collateral_ratestringrequired

The Margin or Collateral rate to be used by both parties when calculating the contract price and value. (ie. 102%)

collateral_typestring(aurora.core.consts.agreements.CollateralType)required
Enum"COLLATERAL_TYPE_UNSPECIFIED""CASH""NON_CASH_UST""NON_CASH_EQ""NON_CASH_JGB"
counterparty_idstringrequired

This will be the Provable assigned company_id. See the Company endpoint for more details.

delivery_typestring(aurora.core.consts.agreements.DeliveryType)required
Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
dividend_requiredstringrequired
pricing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
profit_centerstring
rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
rwa_bucketstring
settlement_systemstring(aurora.core.consts.agreements.SettlementSystem)
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
short_namestringrequired

Agreements require a short name that can be used for both display in the order book and when creating new orders. Short names must be unique amongst your agreements and must be 25 characters or less. Names are case sensitive. Spaces are supported but not recommended.

sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
term_end_datestring
term_start_datestring
term_typestring(aurora.core.consts.agreements.TermType)required
Enum"TERM_TYPE_UNSPECIFIED""NONE""FIXED""EVERGREEN""ONE_DAY""BULLET"
trade_typestring
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.agreementsv1.AgreementService/CreateAgreement \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "balance_target": "string",
    "balance_target_variance": "string",
    "billing_currency": "USD",
    "booking_account": "string",
    "collateral_currency": "USD",
    "collateral_method": "COLLATERAL_METHOD_UNSPECIFIED",
    "collateral_rate": "string",
    "collateral_type": "COLLATERAL_TYPE_UNSPECIFIED",
    "counterparty_id": "string",
    "delivery_type": "DELIVERY_TYPE_UNSPECIFIED",
    "dividend_required": "string",
    "pricing_currency": "USD",
    "profit_center": "string",
    "rounding_rule": "NO_ROUNDING",
    "rwa_bucket": "string",
    "settlement_system": "SETTLEMENT_SYSTEM_UNSPECIFIED",
    "settlement_type": "NSCC",
    "short_name": "string",
    "side": "BORROW",
    "term_end_date": "string",
    "term_start_date": "string",
    "term_type": "TERM_TYPE_UNSPECIFIED",
    "trade_type": "string"
  }'

Responses

A successful response
Create-Agreement Response

Bodyapplication/json
agreementobject(aurora.core.apiengine.agreementsv1.Agreement)required

Fields: id, short_name, side, counterparty_id, settlement_type, rounding_rule, collateral_rate, status, proposer_user, proposed_by_side, responder_user, version, collateral_type, pricing_currency, billing_currency, collateral_currency, collateral_method, dividend_required, term_type, term_start_date, term_end_date, balance_target, balance_target_variance, rwa_bucket, settlement_system, created_at, approved_at, booking_account, counterparty_booking_account, trade_type, profit_center, delivery_type

agreement.​approved_atstring

Datetime that agreement was approved by the second party - time in RFC3339 with millisecond precision

agreement.​balance_targetstring
agreement.​balance_target_variancestring
agreement.​billing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​booking_accountstring
agreement.​collateral_currencystring(aurora.core.common.protos.Currency)
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​collateral_methodstring(aurora.core.consts.agreements.CollateralMethod)required
Enum"COLLATERAL_METHOD_UNSPECIFIED""PLEDGE""TITLE_TRANSFER"
agreement.​collateral_ratestringrequired

Collateral Rate

agreement.​collateral_typestring(aurora.core.consts.agreements.CollateralType)required
Enum"COLLATERAL_TYPE_UNSPECIFIED""CASH""NON_CASH_UST""NON_CASH_EQ""NON_CASH_JGB"
agreement.​counterparty_booking_accountstring
agreement.​counterparty_idstringrequired

The Provable assigned company_id of the counterparty in the agreement

agreement.​created_atstringrequired

Datetime that agreement was initially created - time in RFC3339 with millisecond precision

agreement.​delivery_typestring(aurora.core.consts.agreements.DeliveryType)required
Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
agreement.​dividend_requiredstringrequired
agreement.​idstringrequired

A unique reference for the agreement assigned by Provable Markets

agreement.​pricing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​profit_centerstring
agreement.​proposed_by_sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
agreement.​proposer_userstringrequired

The user who initially created the agreement

agreement.​responder_userstring

The user who approved or rejected the agreement

agreement.​rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
agreement.​rwa_bucketstring
agreement.​settlement_systemstring(aurora.core.consts.agreements.SettlementSystem)
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
agreement.​settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
agreement.​short_namestringrequired

The short name your company has assigned to this agreement

agreement.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
agreement.​statusstring(aurora.core.consts.agreements.AgreementStatus)required

possible agreement status

Enum"AGREEMENT_STATUS_UNSPECIFIED""DRAFT""ACTIVE""REJECTED""CANCELED""INACTIVE"
agreement.​term_end_datestring
agreement.​term_start_datestring
agreement.​term_typestring(aurora.core.consts.agreements.TermType)required
Enum"TERM_TYPE_UNSPECIFIED""NONE""FIXED""EVERGREEN""ONE_DAY""BULLET"
agreement.​trade_typestring
agreement.​versionstring(int64)required

After modifications are accepted, the sequential count changes to the next value. Note: Short Name changes do not result in a new version. Just shared element updates do.

Response
application/json
{
  "agreement": {
    "approved_at": "string",
    "balance_target": "string",
    "balance_target_variance": "string",
    "billing_currency": "USD",
    "booking_account": "string",
    "collateral_currency": "USD",
    "collateral_method": "COLLATERAL_METHOD_UNSPECIFIED",
    "collateral_rate": "string",
    "collateral_type": "COLLATERAL_TYPE_UNSPECIFIED",
    "counterparty_booking_account": "string",
    "counterparty_id": "string",
    "created_at": "string",
    "delivery_type": "DELIVERY_TYPE_UNSPECIFIED",
    "dividend_required": "string",
    "id": "string",
    "pricing_currency": "USD",
    "profit_center": "string",
    "proposed_by_side": "BORROW",
    "proposer_user": "string",
    "responder_user": "string",
    "rounding_rule": "NO_ROUNDING",
    "rwa_bucket": "string",
    "settlement_system": "SETTLEMENT_SYSTEM_UNSPECIFIED",
    "settlement_type": "NSCC",
    "short_name": "string",
    "side": "BORROW",
    "status": "AGREEMENT_STATUS_UNSPECIFIED",
    "term_end_date": "string",
    "term_start_date": "string",
    "term_type": "TERM_TYPE_UNSPECIFIED",
    "trade_type": "string",
    "version": "string"
  }
}

GetAgreement

Request

PATH: /aurora.core.apiengine.agreementsv1.AgreementService/GetAgreement

GetAgreement can be used to get an agreement

Security
Bearer
Bodyapplication/jsonrequired
idstringrequired
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.agreementsv1.AgreementService/GetAgreement \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string"
  }'

Responses

A successful response

Bodyapplication/json
agreementobject(aurora.core.apiengine.agreementsv1.Agreement)required

Fields: id, short_name, side, counterparty_id, settlement_type, rounding_rule, collateral_rate, status, proposer_user, proposed_by_side, responder_user, version, collateral_type, pricing_currency, billing_currency, collateral_currency, collateral_method, dividend_required, term_type, term_start_date, term_end_date, balance_target, balance_target_variance, rwa_bucket, settlement_system, created_at, approved_at, booking_account, counterparty_booking_account, trade_type, profit_center, delivery_type

agreement.​approved_atstring

Datetime that agreement was approved by the second party - time in RFC3339 with millisecond precision

agreement.​balance_targetstring
agreement.​balance_target_variancestring
agreement.​billing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​booking_accountstring
agreement.​collateral_currencystring(aurora.core.common.protos.Currency)
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​collateral_methodstring(aurora.core.consts.agreements.CollateralMethod)required
Enum"COLLATERAL_METHOD_UNSPECIFIED""PLEDGE""TITLE_TRANSFER"
agreement.​collateral_ratestringrequired

Collateral Rate

agreement.​collateral_typestring(aurora.core.consts.agreements.CollateralType)required
Enum"COLLATERAL_TYPE_UNSPECIFIED""CASH""NON_CASH_UST""NON_CASH_EQ""NON_CASH_JGB"
agreement.​counterparty_booking_accountstring
agreement.​counterparty_idstringrequired

The Provable assigned company_id of the counterparty in the agreement

agreement.​created_atstringrequired

Datetime that agreement was initially created - time in RFC3339 with millisecond precision

agreement.​delivery_typestring(aurora.core.consts.agreements.DeliveryType)required
Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
agreement.​dividend_requiredstringrequired
agreement.​idstringrequired

A unique reference for the agreement assigned by Provable Markets

agreement.​pricing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​profit_centerstring
agreement.​proposed_by_sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
agreement.​proposer_userstringrequired

The user who initially created the agreement

agreement.​responder_userstring

The user who approved or rejected the agreement

agreement.​rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
agreement.​rwa_bucketstring
agreement.​settlement_systemstring(aurora.core.consts.agreements.SettlementSystem)
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
agreement.​settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
agreement.​short_namestringrequired

The short name your company has assigned to this agreement

agreement.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
agreement.​statusstring(aurora.core.consts.agreements.AgreementStatus)required

possible agreement status

Enum"AGREEMENT_STATUS_UNSPECIFIED""DRAFT""ACTIVE""REJECTED""CANCELED""INACTIVE"
agreement.​term_end_datestring
agreement.​term_start_datestring
agreement.​term_typestring(aurora.core.consts.agreements.TermType)required
Enum"TERM_TYPE_UNSPECIFIED""NONE""FIXED""EVERGREEN""ONE_DAY""BULLET"
agreement.​trade_typestring
agreement.​versionstring(int64)required

After modifications are accepted, the sequential count changes to the next value. Note: Short Name changes do not result in a new version. Just shared element updates do.

Response
application/json
{
  "agreement": {
    "approved_at": "string",
    "balance_target": "string",
    "balance_target_variance": "string",
    "billing_currency": "USD",
    "booking_account": "string",
    "collateral_currency": "USD",
    "collateral_method": "COLLATERAL_METHOD_UNSPECIFIED",
    "collateral_rate": "string",
    "collateral_type": "COLLATERAL_TYPE_UNSPECIFIED",
    "counterparty_booking_account": "string",
    "counterparty_id": "string",
    "created_at": "string",
    "delivery_type": "DELIVERY_TYPE_UNSPECIFIED",
    "dividend_required": "string",
    "id": "string",
    "pricing_currency": "USD",
    "profit_center": "string",
    "proposed_by_side": "BORROW",
    "proposer_user": "string",
    "responder_user": "string",
    "rounding_rule": "NO_ROUNDING",
    "rwa_bucket": "string",
    "settlement_system": "SETTLEMENT_SYSTEM_UNSPECIFIED",
    "settlement_type": "NSCC",
    "short_name": "string",
    "side": "BORROW",
    "status": "AGREEMENT_STATUS_UNSPECIFIED",
    "term_end_date": "string",
    "term_start_date": "string",
    "term_type": "TERM_TYPE_UNSPECIFIED",
    "trade_type": "string",
    "version": "string"
  }
}

ListAgreements

Request

PATH: /aurora.core.apiengine.agreementsv1.AgreementService/ListAgreements

ListAgreements can be used to query agreements

Security
Bearer
Bodyapplication/jsonrequired

List-Agreements Request

booking_accountsArray of strings
collateral_currenciesArray of strings(aurora.core.common.protos.Currency)
Items Enum"USD""CAD""GBP""EUR""JPY"
counterparty_booking_accountsArray of strings
counterparty_idsArray of strings
delivery_typesArray of strings(aurora.core.consts.agreements.DeliveryType)
Items Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
eligible_instrumentstring

Cusip or Ticker of instrument

sidestring(aurora.core.consts.common.Side)
Enum"BORROW""LOAN"
statusesArray of strings(aurora.core.consts.agreements.AgreementStatus)

The list of status of the agreements you wish to query.

Items Enum"AGREEMENT_STATUS_UNSPECIFIED""DRAFT""ACTIVE""REJECTED""CANCELED""INACTIVE"
trade_typesArray of strings
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.agreementsv1.AgreementService/ListAgreements \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "booking_accounts": [
      "string"
    ],
    "collateral_currencies": [
      "USD"
    ],
    "counterparty_booking_accounts": [
      "string"
    ],
    "counterparty_ids": [
      "string"
    ],
    "delivery_types": [
      "DELIVERY_TYPE_UNSPECIFIED"
    ],
    "eligible_instrument": "string",
    "side": "BORROW",
    "statuses": [
      "AGREEMENT_STATUS_UNSPECIFIED"
    ],
    "trade_types": [
      "string"
    ]
  }'

Responses

A successful response
List-Agreements Response

Bodyapplication/json
agreementsArray of objects(aurora.core.apiengine.agreementsv1.Agreement)

List of agreements

Response
application/json
{
  "agreements": [
    { … }
  ]
}

ModifyAgreement

Request

PATH: /aurora.core.apiengine.agreementsv1.AgreementService/ModifyAgreement

ModifyAgreement can be used to create a new version of an agreement

Security
Bearer
Bodyapplication/jsonrequired

Modify-Agreement Request

balance_targetstring
balance_target_variancestring
billing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
booking_accountstring
collateral_currencystring(aurora.core.common.protos.Currency)
Enum"USD""CAD""GBP""EUR""JPY"
collateral_methodstring(aurora.core.consts.agreements.CollateralMethod)required
Enum"COLLATERAL_METHOD_UNSPECIFIED""PLEDGE""TITLE_TRANSFER"
collateral_ratestringrequired

Updated Margin / Collateral Rate

collateral_typestring(aurora.core.consts.agreements.CollateralType)required
Enum"COLLATERAL_TYPE_UNSPECIFIED""CASH""NON_CASH_UST""NON_CASH_EQ""NON_CASH_JGB"
delivery_typestring(aurora.core.consts.agreements.DeliveryType)required
Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
dividend_requiredstringrequired
idstringrequired

The reference for the agreement you wish to modify

pricing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
profit_centerstring
rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
rwa_bucketstring
settlement_systemstring(aurora.core.consts.agreements.SettlementSystem)
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
short_namestringrequired

Agreements require a short name that can be used for both display in the order book and when creating new orders. Short names must be unique amongst your agreements and must be 25 characters or less. Spaces are supported but not recommended.

term_end_datestring
term_start_datestring
term_typestring(aurora.core.consts.agreements.TermType)required
Enum"TERM_TYPE_UNSPECIFIED""NONE""FIXED""EVERGREEN""ONE_DAY""BULLET"
trade_typestring
curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.agreementsv1.AgreementService/ModifyAgreement \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "balance_target": "string",
    "balance_target_variance": "string",
    "billing_currency": "USD",
    "booking_account": "string",
    "collateral_currency": "USD",
    "collateral_method": "COLLATERAL_METHOD_UNSPECIFIED",
    "collateral_rate": "string",
    "collateral_type": "COLLATERAL_TYPE_UNSPECIFIED",
    "delivery_type": "DELIVERY_TYPE_UNSPECIFIED",
    "dividend_required": "string",
    "id": "string",
    "pricing_currency": "USD",
    "profit_center": "string",
    "rounding_rule": "NO_ROUNDING",
    "rwa_bucket": "string",
    "settlement_system": "SETTLEMENT_SYSTEM_UNSPECIFIED",
    "settlement_type": "NSCC",
    "short_name": "string",
    "term_end_date": "string",
    "term_start_date": "string",
    "term_type": "TERM_TYPE_UNSPECIFIED",
    "trade_type": "string"
  }'

Responses

A successful response
Modify-Agreement Response

Bodyapplication/json
agreementobject(aurora.core.apiengine.agreementsv1.Agreement)required

Fields: id, short_name, side, counterparty_id, settlement_type, rounding_rule, collateral_rate, status, proposer_user, proposed_by_side, responder_user, version, collateral_type, pricing_currency, billing_currency, collateral_currency, collateral_method, dividend_required, term_type, term_start_date, term_end_date, balance_target, balance_target_variance, rwa_bucket, settlement_system, created_at, approved_at, booking_account, counterparty_booking_account, trade_type, profit_center, delivery_type

agreement.​approved_atstring

Datetime that agreement was approved by the second party - time in RFC3339 with millisecond precision

agreement.​balance_targetstring
agreement.​balance_target_variancestring
agreement.​billing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​booking_accountstring
agreement.​collateral_currencystring(aurora.core.common.protos.Currency)
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​collateral_methodstring(aurora.core.consts.agreements.CollateralMethod)required
Enum"COLLATERAL_METHOD_UNSPECIFIED""PLEDGE""TITLE_TRANSFER"
agreement.​collateral_ratestringrequired

Collateral Rate

agreement.​collateral_typestring(aurora.core.consts.agreements.CollateralType)required
Enum"COLLATERAL_TYPE_UNSPECIFIED""CASH""NON_CASH_UST""NON_CASH_EQ""NON_CASH_JGB"
agreement.​counterparty_booking_accountstring
agreement.​counterparty_idstringrequired

The Provable assigned company_id of the counterparty in the agreement

agreement.​created_atstringrequired

Datetime that agreement was initially created - time in RFC3339 with millisecond precision

agreement.​delivery_typestring(aurora.core.consts.agreements.DeliveryType)required
Enum"DELIVERY_TYPE_UNSPECIFIED""DVP""FOP"
agreement.​dividend_requiredstringrequired
agreement.​idstringrequired

A unique reference for the agreement assigned by Provable Markets

agreement.​pricing_currencystring(aurora.core.common.protos.Currency)required
Enum"USD""CAD""GBP""EUR""JPY"
agreement.​profit_centerstring
agreement.​proposed_by_sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
agreement.​proposer_userstringrequired

The user who initially created the agreement

agreement.​responder_userstring

The user who approved or rejected the agreement

agreement.​rounding_rulestring(aurora.core.consts.RoundingRule)required
Enum"NO_ROUNDING""UP_TO_NEAREST_0_DOT_01""UP_TO_NEAREST_0_DOT_05""UP_TO_NEAREST_0_DOT_10""UP_TO_NEAREST_0_DOT_25""UP_TO_NEAREST_1_DOT_0"
agreement.​rwa_bucketstring
agreement.​settlement_systemstring(aurora.core.consts.agreements.SettlementSystem)
Enum"SETTLEMENT_SYSTEM_UNSPECIFIED""PROVABLE_MARKET""LOANET""LOANET_SFT""SPIRE""PROP"
agreement.​settlement_typestring(aurora.core.consts.settlement.SettlementType)required
Enum"NSCC""BILATERAL"
agreement.​short_namestringrequired

The short name your company has assigned to this agreement

agreement.​sidestring(aurora.core.consts.common.Side)required
Enum"BORROW""LOAN"
agreement.​statusstring(aurora.core.consts.agreements.AgreementStatus)required

possible agreement status

Enum"AGREEMENT_STATUS_UNSPECIFIED""DRAFT""ACTIVE""REJECTED""CANCELED""INACTIVE"
agreement.​term_end_datestring
agreement.​term_start_datestring
agreement.​term_typestring(aurora.core.consts.agreements.TermType)required
Enum"TERM_TYPE_UNSPECIFIED""NONE""FIXED""EVERGREEN""ONE_DAY""BULLET"
agreement.​trade_typestring
agreement.​versionstring(int64)required

After modifications are accepted, the sequential count changes to the next value. Note: Short Name changes do not result in a new version. Just shared element updates do.

Response
application/json
{
  "agreement": {
    "approved_at": "string",
    "balance_target": "string",
    "balance_target_variance": "string",
    "billing_currency": "USD",
    "booking_account": "string",
    "collateral_currency": "USD",
    "collateral_method": "COLLATERAL_METHOD_UNSPECIFIED",
    "collateral_rate": "string",
    "collateral_type": "COLLATERAL_TYPE_UNSPECIFIED",
    "counterparty_booking_account": "string",
    "counterparty_id": "string",
    "created_at": "string",
    "delivery_type": "DELIVERY_TYPE_UNSPECIFIED",
    "dividend_required": "string",
    "id": "string",
    "pricing_currency": "USD",
    "profit_center": "string",
    "proposed_by_side": "BORROW",
    "proposer_user": "string",
    "responder_user": "string",
    "rounding_rule": "NO_ROUNDING",
    "rwa_bucket": "string",
    "settlement_system": "SETTLEMENT_SYSTEM_UNSPECIFIED",
    "settlement_type": "NSCC",
    "short_name": "string",
    "side": "BORROW",
    "status": "AGREEMENT_STATUS_UNSPECIFIED",
    "term_end_date": "string",
    "term_start_date": "string",
    "term_type": "TERM_TYPE_UNSPECIFIED",
    "trade_type": "string",
    "version": "string"
  }
}

RejectAgreement

Request

PATH: /aurora.core.apiengine.agreementsv1.AgreementService/RejectAgreement

RejectAgreement can be used to reject a drafted agreement

Security
Bearer
Bodyapplication/jsonrequired

Reject-Agreement Request

idstringrequired

ID of the agreement

curl -i -X POST \
  https://developer.provablemarkets.com/_mock/apis/connectapi/aurora.core.apiengine.agreementsv1.AgreementService/RejectAgreement \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string"
  }'

Responses

A successful response
Reject-Agreement Response

Bodyapplication/json
object(aurora.core.apiengine.agreementsv1.RejectAgreementResponse)

Reject-Agreement Response

Response
application/json
{}

ContractRequestEventsService

Operations

ContractRequestService

Operations

InstrumentService

Operations

ExecutionEventsService

Operations

ExecutionService

Operations

VenueEventsService

Operations

VenueService

Operations

LoginService

Operations