ALalpacahq
Instant Funding

Get a single settlement

Returns the settlement specified by the path parameter.

get/v1/instant_funding/settlements/{settlement_id}

Request

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

Path parameters

settlement_idstring uuid required

ID of the settlement

Response

Successful response.

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.