SHshinkansen
Internal

Returns validation batches for a given customer

Used internally by Shinkansen (e.g, for the Shinkansen Dashboard).

get/internal/customers/{customer_shinkansen_fin_id}/validation_batches

Request

  • Base URL
    https://api.validator.shinkansen.finance/v1
  • URL
    https://api.validator.shinkansen.finance/v1/internal/customers/{customer_shinkansen_fin_id}/validation_batches
  • Auth
    API key in header Shinkansen-Validator-Api-Key

Query parameters

page_sizeinteger

Maximum number of validation batches to return per page (can't be greater than 100)

pageinteger

Current page to fetch (defaults to 1 if not specified)

status'pending' | 'performed'

Filter by status of validation batch (note that the individual validation requests have their own status)

idstring

Filter by external facing id of validation batch

before_datetimestring date-time

Filter by validation batches inserted before this datetime

after_datetimestring date-time

Filter by validation batches inserted after this datetime

Response

Returns a list of validation batches plus pagination metadata

Example response

{
  "meta": {
    "current_page": 1,
    "previous_page": null,
    "next_page": 2,
    "page_size": 2,
    "total_count": 3,
    "total_pages": 2
  },
  "validation_batches": [
    {
      "id": "7g55hi82-hide-85if-e7g5-f3i34e4he407",
      "source_type": "file",
      "source_name": "batch_file.csv",
      "inserted_at": "2022-04-08T18:25:45-04:00",
      "updated_at": "2022-04-08T18:25:55-04:00",
      "status": "performed"
    },
    {
      "id": "8h66ij93-ijef-96jg-f8h6-g4j45f5if518",
      "source_type": "file",
      "source_name": "batch_file.csv",
      "inserted_at": "2022-04-08T18:25:45-04:00",
      "updated_at": "2022-04-08T18:25:45-04:00",
      "status": "pending"
    }
  ]
}

Changes

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