JUjustifi
Payment Method Imports

List Payment Method Imports

List the payment method imports run across your platform, newest first. To list only one sub account's imports, send its id in the Sub-Account header or the sub_account_id parameter. This endpoint supports pagination.

get/payment_method_imports

Request

Query parameters

sub_account_idstring

filter records by the sub account the payment methods were imported into. A sub account outside your platform returns no records.

status'created' | 'processing' | 'successful' | 'failed'

filter records by the import status. Unknown values are ignored.

provider'authorize_net' | 'braintree' | 'datacap' | 'ez_facility' | 'mind_body' | 'neon_pay' | 'paragon' | 'paya' | 'stripe'

filter records by the processor the payment methods were migrated from. Unknown values are ignored.

created_beforestring date-time

filter records which were created before the date and time (UTC) specified. Dates without time specified will default to 00:00:00

created_afterstring date-time

filter records which were created after the date and time (UTC) specified. Dates without time specified will default to 00:00:00

limitinteger

the number of resources to retrieve

before_cursorstring

token to fetch the previous page of a list

after_cursorstring

token to fetch the next page of a list

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Sub-Accountstring

the id of the sub account that this request applies to

Response

Successfully list payment method imports

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "data": [
    {
      "id": "pmi_123xyz",
      "provider": "stripe",
      "status": "successful",
      "report_file_path": "imports/pmi_123xyz/report.csv",
      "report_file_url": "https://justifi-imports.s3.amazonaws.com/imports/pmi_123xyz/report.csv?X-Amz-Signature=...",
      "account_id": "acc_123xyz",
      "platform_account_id": "acc_456abc",
      "retry_of_payment_method_import_id": "pmi_789def",
      "created_at": "2024-01-01T12:00:00Z",
      "updated_at": "2024-01-01T12:00:00Z"
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.