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

# Get a transfer

> Read one transfer of company money onto a card.

One transfer, in this credential's mode. A transfer waiting on you reads
`status: pending` and `substatus: awaiting_collection`, with the
`collection_deadline` you have to confirm it by.


## OpenAPI

````yaml openapi.json GET /api/v2/company_wallet/transfers/{transfer_id}
openapi: 3.1.0
info:
  title: Agentcard API
  version: 2.0.0
  description: >-
    The Agentcard v2 API — connect your users and verify their identity from
    your own backend. Every call is authenticated with a platform access token
    minted from your `client_id` + `client_secret`.
servers:
  - url: https://api.agentcard.sh
    description: >-
      There is one base URL. Sandbox vs production is decided by the client
      credential you use, never by the host.
security:
  - platformToken: []
tags:
  - name: Authentication
    description: >-
      Exchange your client credentials for a platform access token, and
      introspect what a token acts as.
  - name: Connect
    description: >-
      Connect a user to your platform: send a one-time code, verify it, record
      consent, and keep the connection alive.
  - name: Identity verification
    description: >-
      Verify a connected user's identity: upload their ID, submit any extra
      fields we ask for, then show a short face scan.
paths:
  /api/v2/company_wallet/transfers/{transfer_id}:
    get:
      tags:
        - Company wallet
      summary: Get a transfer
      description: One transfer of company money onto a card.
      operationId: companyWalletTransferGet
      parameters:
        - name: transfer_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The transfer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyWalletTransfer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: >-
            `transfer_not_found`: no such transfer on your company, in this
            credential's mode.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - platformToken: []
components:
  schemas:
    CompanyWalletTransfer:
      type: object
      required:
        - object
        - id
        - status
        - substatus
        - kind
        - user_id
        - amount_cents
        - livemode
        - created_at
      properties:
        object:
          type: string
          description: Always `company_wallet_transfer`.
          enum:
            - company_wallet_transfer
        id:
          type: string
        status:
          type: string
          enum:
            - pending
            - funded
            - consumed
            - reclaimed
            - failed
          description: >-
            `pending` until the money reaches the card, `funded` once it has,
            `consumed` once the card holds it, `reclaimed` once a closed card
            gave it back, `failed` when it never moved.
        substatus:
          type: string
          description: >-
            Where a `pending` transfer is: `awaiting_collection` (waiting on
            you), `collection_confirmed` or `transferring`.
        kind:
          type: string
          description: '`mint` for a new card, `top_up` for a raise on an existing one.'
        user_id:
          type:
            - string
            - 'null'
          description: The user the card is for.
        card_id:
          type:
            - string
            - 'null'
          description: The card the transfer made or raised.
        amount_cents:
          type: integer
          description: What the card asked for.
        fee_cents:
          type: integer
          description: The fee on top.
        transferred_cents:
          type: integer
          description: What has moved so far.
        released_cents:
          type: integer
          description: >-
            What a closed card gave back. It counts toward the user's next card
            until you recover it.
        failure_reason:
          type:
            - string
            - 'null'
          description: Why a `failed` transfer failed.
        collection_deadline:
          type:
            - string
            - 'null'
          description: When a transfer waiting on you fails if you haven't confirmed it.
        livemode:
          type: boolean
          description: '`false` on a sandbox credential.'
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      description: Every v2 error uses the same envelope.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: A stable, machine-readable string (snake_case). Branch on this.
            message:
              type: string
              description: A human-readable explanation, safe to log.
            docs:
              type: string
              description: A link back to the reference.
            field_errors:
              type: object
              additionalProperties:
                type: string
              description: Only on `invalid_fields` — names each field to fix.
            warnings:
              type: array
              items:
                type: string
              description: >-
                Only on document upload errors — actionable feedback safe to
                show the user.
  responses:
    Unauthorized:
      description: >-
        `unauthorized` — the platform access token is missing or expired.
        Exchange your client credentials for a fresh one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    platformToken:
      type: http
      scheme: bearer
      description: >-
        A platform access token. Get one on the **Create an access token**
        endpoint by exchanging your `client_id` + `client_secret`, then send it
        as `Authorization: Bearer <token>`. Tokens live one hour.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.