> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leapfinancial.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Credit Funds

<Warning>
  **This API MUST be implemented by the Partner.** Platform's backend will notify the final fund credit to the user's account.
</Warning>

Our backend will consume this service by performing a `POST` request to:

`[Base-URL]/CreditFunds`.

Our service will check `CreditResponseType` configuration. If `Sync`, the response will be immediate. If `Async`, status will be checked by `Get Credit Status` endpoint.

**Expected behavior:**
Payment order (credit) to a virtual network account. We will send a notification to indicate that funds should be settled in favor of an `AccountIdentifier` for the stipulated amount. The destination system must respond whether the action was successful (`Success`), returning a trace and/or the reason why it failed (`NonCreditReason`).


## OpenAPI

````yaml swagger-client-interfaces.json POST /client-interfaces/vna/credit-funds
openapi: 3.0.0
info:
  title: ''
  version: 0.0.1
servers: []
security: []
paths:
  /client-interfaces/vna/credit-funds:
    post:
      tags:
        - Partner Implemented APIs
      summary: Credit funds
      operationId: creditFundsClientApi
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditFundsRequest'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditFundsResponse'
      security: []
components:
  schemas:
    CreditFundsRequest:
      properties:
        TransactionId:
          type: string
        AuthTrackingIdentifier:
          type: string
        AccountIdentifier:
          type: string
        Amount:
          type: number
          format: double
          description: Required only if AuthTrackingIdentifier is empty.
        Currency:
          type: string
          description: 3 chars. Required only if AuthTrackingIdentifier is empty.
        ExchangeRate:
          type: number
          format: double
          description: Required only if AuthTrackingIdentifier is empty.
      required:
        - TransactionId
        - AccountIdentifier
      type: object
      additionalProperties: false
    CreditFundsResponse:
      properties:
        Success:
          type: boolean
        TrackingIdentifier:
          type: string
        NonCreditReason:
          $ref: '#/components/schemas/NonCreditReason'
      required:
        - Success
        - TrackingIdentifier
      type: object
      additionalProperties: false
    NonCreditReason:
      type: string
      enum:
        - None
        - AccountBlocked
        - AccountBlockedByLaw
        - AccountBlockedByGovernment
        - ByVelocity
        - ByAmountLimit
        - ByAccumulateAmountLimit
        - InvalidAccount
        - InvalidParameter
        - InvalidCurrency
        - InvalidSenderData
        - InvalidDestinationData
        - InvalidExchangeRate
        - NotPreviouslyValidated
        - InvalidReferenceId
        - InvalidAmount

````