> ## 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.

# Get Credit Status

<Warning>
  **This API MUST be implemented by the Partner.** Platform's backend will query the status of a previous credit operation.
</Warning>

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

`[Base-URL]/GetCreditStatus`.

Our backend will perform this request every `CreditStatusQueryRepetitionsInMinutes` minutes.

**Expected behavior:**
Asynchronous query of the status of a previous funds credit order. With the tracking number (`CreditTrackingNumber`), the partner will report if the credit is in progress (`InProgress`), approved (`Approved`), or if it ended in an error (`Failed`).


## OpenAPI

````yaml swagger-client-interfaces.json POST /client-interfaces/vna/get-credit-status
openapi: 3.0.0
info:
  title: ''
  version: 0.0.1
servers: []
security: []
paths:
  /client-interfaces/vna/get-credit-status:
    post:
      tags:
        - Partner Implemented APIs
      summary: Get credit status
      operationId: getCreditStatusClientApi
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCreditStatusRequest'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCreditStatusResponse'
      security: []
components:
  schemas:
    GetCreditStatusRequest:
      properties:
        TransactionId:
          type: string
        AccountIdentifier:
          type: string
        CreditTrackingNumber:
          type: string
      required:
        - TransactionId
        - AccountIdentifier
        - CreditTrackingNumber
      type: object
      additionalProperties: false
    GetCreditStatusResponse:
      properties:
        CreditStatus:
          $ref: '#/components/schemas/CreditStatus'
        ResponseDescription:
          type: string
      required:
        - CreditStatus
      type: object
      additionalProperties: false
    CreditStatus:
      type: string
      enum:
        - InProgress
        - Approved
        - Failed

````