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

# Sync route deposits

> Pulls latest deposit state for the route. Requires `api:write` scope and `Idempotency-Key`.



## OpenAPI

````yaml /openapi.yaml post /payment-routes/{paymentRouteId}/deposits/sync
openapi: 3.1.0
info:
  title: Remitflex API
  version: 1.0.0
  description: >
    Programmatic access to Remitflex payment routes, fiat rates, customers, and
    transactions.


    **Dashboard:** Create API keys at https://dashboard.remitflex.io


    **Authentication:** Send your API key as `Authorization: Bearer
    rmf_live_...` or `rmf_test_...`.


    **Idempotency:** Mutating requests (`POST`, `PUT`, `PATCH`, `DELETE`)
    require an `Idempotency-Key` header when authenticated with an API key.
servers:
  - url: http://localhost:4000/v1
    description: Local development
  - url: https://api.remitflex.io/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /payment-routes/{paymentRouteId}/deposits/sync:
    post:
      tags:
        - Payment routes
      summary: Sync route deposits
      description: >-
        Pulls latest deposit state for the route. Requires `api:write` scope and
        `Idempotency-Key`.
      operationId: syncPaymentRouteDeposits
      parameters:
        - name: paymentRouteId
          in: path
          required: true
          description: >-
            RemitFlex payment route UUID (`id` from `POST /payment-routes` or
            `GET /payment-routes`).
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          $ref: '#/components/responses/SyncDeposits'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >-
        Unique key for safe retries on mutating API-key requests. Cached for 24
        hours per org, method, and path.
      schema:
        type: string
        maxLength: 255
        example: 7f3c2a1b-4e5d-6c7b-8a9f-0e1d2c3b4a5f
  responses:
    SyncDeposits:
      description: Deposit sync result
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/SuccessEnvelope'
              - type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SyncDepositsResult'
          examples:
            success:
              $ref: '#/components/examples/SyncDepositsResponse'
  schemas:
    SuccessEnvelope:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          nullable: true
    SyncDepositsResult:
      type: object
      properties:
        synced:
          type: integer
        routeId:
          type: string
          format: uuid
  examples:
    SyncDepositsResponse:
      value:
        status: success
        message: Payment route deposits synced
        data:
          synced: 2
          routeId: route-uuid-001
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >
        API key created in the Remitflex Dashboard at dashboard.remitflex.io
        (`rmf_live_...` or `rmf_test_...`).

        Key management endpoints require a dashboard JWT and are not part of
        this reference.

````