ALalpacahq
Instant Funding

Create a new settlement

Creates a new settlement, which will trigger the reconciliation process for all included transfers and their interests. There is a limit of 50,000 transfers per settlement. If more than 50,000 transfers need to be settled, they should be batched in multiple settlements.

post/v1/instant_funding/settlements

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/instant_funding/settlements
  • Auth
    HTTP basic

Request body

additional_infostring

Additional remittance information. Include if the funding source may require additional information to associate to the source account or settlement.

Response

Settlement created.

additional_infostring
asset_class'crypto' | 'us_equity'

Values:

  • crypto: Used to identify a crypto only account
  • us_equity: Used to identify an account that trades US equities, or both crypto and US equities.
completed_atstring date-time
created_atstring date-time required
currencystring

The currency of the settlement. Only applicable to JIT settlements.

idstring uuid required
interest_amountstring decimal

The total interest amount accrued on the transfers included in this settlement. Only applicable for instant funding settlements.

reasonstring

The reason for failure, if applicable

source_account_numberstring
status'PENDING' | 'AWAITING_ADDITIONAL_FUNDS' | 'COMPLETED' | 'FAILED' required

Values:

  • PENDING: Created and waiting to be processed
  • AWAITING_ADDITIONAL_FUNDS: Waiting for additional funds to be deposited
  • COMPLETED: All transactions are reconciled
  • FAILED: Attempt to process this settlement has failed. If this is observed additional remittance information may be required, or one of the transfers being settled accrued additional interest since the settlement was created.
total_amountstring decimal required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.