# Create Settlement Funding Transfer Attempt

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

Endpoint: POST /settlements/{settlement_id}/funding_transfer_attempts
Security: BasicAuth

## Path parameters:

  - `settlement_id` (string, required)
    The ID of Settlement.
    Example: "STcAm13tv77jyt5n3KQ553X"

## Header parameters:

  - `Finix-Version` (string)
    Specify the API version of your request. For more details, see Versioning.
    Example: "2022-02-01"

  - `Content-Type` (string)
    The data type being sent in the request body must be application/json.
    Example: "application/json"

## Request fields (application/json):

  - `amount` (number)
    The amount in cents to be paid out via instant payout.

  - `instrument_id` (string)
    The Payment Instrument used to submit the funds. The instrument must currently be of type PAYMENT_CARD.

## Response 201 fields (application/json):

  - `id` (string)
    The ID of the resource.

  - `created_at` (string)
    Timestamp of when the object was created.

  - `updated_at` (string)
    Timestamp of when the object was last updated.

  - `amount` (integer)
    The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
    Example: 5000

  - `application` (string)
    ID of the Application the resource was created under.

  - `currency` (string)
    ISO 4217 3-letter currency code.
    Enum: "CAD", "USD"

  - `funding_transfer_id` (string)
    The ID of the Transfer used to track the payout.

  - `instrument_id` (string,null)
    The ID of the Payment Instrument to use for the instant payout.

  - `merchant_id` (string)
    The ID of the Merchant resource for the Funding Transfer Attempt.
    Example: "MUxxxxxxxxxxxxxxxxxxxxxxx"

  - `failure_code` (string,null)
    The error code when the Funding Transfer Attempt fails.
    Enum: "BALANCE_ACCOUNT_NOT_FOUND", "BALANCE_VALIDATION_FAILED", "INSUFFICIENT_BALANCE", "INVALID_BALANCE_ACCOUNT", "VELOCITY_LIMIT_EXCEEDED", "VELOCITY_RULE_NOT_FOUND", "VELOCITY_VALIDATION_FAILED"

  - `failure_message` (string,null)
    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` (string)
    The status of the Funding Transfer Attempt.
    Enum: "PENDING", "FAILED", "SUCCEEDED"

  - `settlement_id` (any)
    The ID of the Settlement resource used for this Funding Transfer Attempt.

  - `_links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

  - `_links.self` (object)
    Link to the resource that was used in the request.

  - `_links.self.href` (string)

## Response 400 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 401 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 403 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 406 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.