Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Settlements

Create Settlement Funding Transfer Attempt

Create a Funding Transfer Attempt for this Settlement. Funding transfer attempts are used to submit funds for instant payout.

post/settlements/{settlement_id}/funding_transfer_attempts

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

amountnumber

The amount in cents to be paid out via instant payout.

instrument_idstring

The Payment Instrument used to submit the funds. The instrument must currently be of type PAYMENT_CARD.

Response

A single settlement Funding Transfer Attempt

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

amountinteger

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

applicationstring

ID of the Application the resource was created under.

currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

funding_transfer_idstring

The ID of the Transfer used to track the payout.

instrument_idstring nullable

The ID of the Payment Instrument to use for the instant payout.

merchant_idstring

The ID of the Merchant resource for the Funding Transfer Attempt.

failure_code'BALANCE_ACCOUNT_NOT_FOUND' | 'BALANCE_VALIDATION_FAILED' | 'INSUFFICIENT_BALANCE' | 'INVALID_BALANCE_ACCOUNT' | 'VELOCITY_LIMIT_EXCEEDED' | 'VELOCITY_RULE_NOT_FOUND' | 'VELOCITY_VALIDATION_FAILED' nullable

The error code when the Funding Transfer Attempt fails.

failure_messagestring nullable

A human-readable message describing why the Funding Transfer Attempt failed. Corresponds to failure_code:

  • BALANCE_ACCOUNT_NOT_FOUND: Balance Account not found. Please contact support if you have questions.
  • BALANCE_VALIDATION_FAILED: Balance Validation failed.
  • INSUFFICIENT_BALANCE: Your account balance is insufficient for this operation. Please contact support if you have any questions.
  • INVALID_BALANCE_ACCOUNT: Balance Account is invalid.
  • VELOCITY_LIMIT_EXCEEDED: Dynamically generated based on the violated rule. Examples: Daily volume limit exceeded for APPLICATION, Monthly count limit exceeded for RECIPIENT, Maximum amount exceeded for SENDER.
  • VELOCITY_RULE_NOT_FOUND: Velocity Rule not found. Please contact support if you have any questions.
  • VELOCITY_VALIDATION_FAILED: Velocity Validation failed. Please contact support if you have any questions.
state'PENDING' | 'FAILED' | 'SUCCEEDED'

The status of the Funding Transfer Attempt.

{"stackTrail":"components:schemas:SettlementFundingTransferAttempt:properties:settlement_id","oasType":"schema","type":"unknown","description":"The ID of the `Settlement` resource used for this `Funding Transfer Attempt`."}

Example response

{
  "amount": 5000,
  "merchant_id": "MUxxxxxxxxxxxxxxxxxxxxxxx"
}