Sign in
Funding Events

Create a funding event for an account

post/v1/funding_events/simulate

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Idempotency-Keystring

Optional client generated value to use for idempotent requests.

Request body

funding_event_job_type'charges' | 'payouts' | 'Charges' | 'Payouts' required

Supported job types are Charges and Payouts

sandbox_outcome'standard' | 'paid' | 'on_hold_daily_limit' | 'cancelled_for_fraud_risk' | 'cancelled_for_balance_check' | 'failed_insufficient_funds' | 'reversed_insufficient_funds' | 'failed_customer_dispute' | 'reversed_customer_dispute' | 'failed_closed_bank_account' | 'reversed_closed_bank_account' | 'Standard' | 'Paid' | 'OnHoldDailyLimit' | 'CancelledForFraudRisk' | 'CancelledForBalanceCheck' | 'FailedInsufficientFunds' | 'ReversedInsufficientFunds' | 'FailedCustomerDispute' | 'ReversedCustomerDispute' | 'FailedClosedBankAccount' | 'ReversedClosedBankAccount'

Payment will simulate processing if not Standard.

Response

Created

response_type'object' | 'array' | 'error' | 'none' | 'Object' | 'Array' | 'Error' | 'None' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Changes