Query parameters

• filter object | string

  The filter(s) to apply to the imports.

• page object | string

  The pagination information for the request.

• include array[string]

  Related resources to include in the response.

  Value is items.

Responses

• 200 application/json

  Retrieved a page of imports successfully.

  Hide response attribute Show response attribute object

  • data array[object] Required

    The page of imports.

    Hide data attributes Show data attributes object

    • clientId string Required

      The identifier of the client that submitted the import, read from its access token.

    • counts object Required

      How many records ended up with which result.

      Hide counts attributes Show counts attributes object

      • failed integer Required

        The number of records that were rejected.

        Minimum value is 0.

      • imported integer Required

        The number of records that created a transaction.

        Minimum value is 0.

      • skipped integer Required

        The number of records whose external id was already imported and that were left unchanged.

        Minimum value is 0.

      • total integer Required

        The number of records that were submitted.

        Minimum value is 0.

    • createdAt string(date-time) Required

      When the import was created.

    • id string(uuid) Required

      The unique identifier of the import.

    • items array[object]

      The result of every submitted record, ordered by position. Only present when requested via the include query parameter.

      Hide items attributes Show items attributes object

      • externalId string Required

        The identifier the importing system assigned to the record.

      • failureCode string | null Required

        Why the record was rejected; null unless the result is FAILED. PAYMENT_METHOD_NOT_FOUND: the payment method is not one of the import user's, which covers a method the payment integration does not know and one that belongs to somebody else.

      • position integer Required

        The 0-based index of the record in the submitted transactions array.

        Minimum value is 0.

      • result string Required

        What became of the record. IMPORTED: a transaction was created. SKIPPED: the external id was already imported, the existing transaction is left unchanged. FAILED: the record was rejected, see failureCode.

        Values are IMPORTED, SKIPPED, or FAILED.

      • transactionId string(uuid) | null Required

        The transaction the record refers to: the one this import created (IMPORTED), the one that already carried the external id (SKIPPED), or null (FAILED).

    • status string Required

      The summary of the record results. COMPLETED: no record failed (skipped records count as success). PARTIAL: some records failed, the others were imported or skipped. FAILED: every record failed. Imports are processed synchronously, so there is no in-progress value.

      Values are COMPLETED, PARTIAL, or FAILED.

    • updatedAt string(date-time) Required

      When the import was last updated.

    • userId string(uuid) Required

      The unique identifier of the user the imported transactions belong to.

• 401

  Client authentication failed.

• 403

  The caller may only read its own imports and filtered for another user.

  Missing one or more required scopes.

• 500

  An internal server error occurred.