Instant Funding

Create an instant funding request

Creates an instant funding request. The request will be processed and the funds will be made available to the account in the form of a Memopost non trade activity. Upon settlement the Memoposted will be corrected to a CSD activity.

Idempotency: When the Idempotency-Key header is supplied, this endpoint is idempotent. Multiple requests with the same key and identical request body will create only one transfer. A subsequent request returns the previously created transfer with the same response (no duplicate is created). If the same key is used with a different request body, the API returns 422 Unprocessable Entity.

Recommended for production: Always supply Idempotency-Key when creating transfers. This allows safe retries on timeouts, network errors, or 5xx responses without risking duplicate transfers. Use a client-generated unique value (e.g. UUID).

post/v1/instant_funding

Request

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

Headers

Idempotency-Keystring

Optional client-generated key for safe retries and duplicate request detection. This endpoint currently accepts keys up to 128 characters. Alpaca is moving toward a 36-character maximum; new implementations should generate a unique UUIDv7 or UUIDv4 value (36 characters including hyphens) for each logical operation. Do not reuse a key across operations.

Request body

account_nostring required
amountstring decimal required
source_account_nostring required

Response

Instant transfer request created.

account_nostring required
amountstring decimal required
created_atstring date-time required
deadlinestring date required
idstring uuid required
remaining_payablestring decimal required
source_account_nostring required
status'PENDING' | 'CANCELED' | 'EXECUTED' | 'FAILED' | 'COMPLETED' required

Status:

  • PENDING: Created and waiting to be processed
  • CANCELED: Canceled
  • EXECUTED: All fees (including Partner fee) are transacted
  • FAILED: Failed mostly due to technical reasons
  • COMPLETED: All transactions are settled
system_datestring date required
total_intereststring decimal required

Changes

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