Marqeta business transitions API

openapi: 3.0.3
info:
  contact:
    email: support@marqeta.com
    name: Marqeta
  description: Marqeta's Core API endpoints, conveniently annotated to enable code generation (including SDKs), test cases, and documentation. Currently in beta.
  termsOfService: https://www.marqeta.com/api-terms
  title: Core accepted countries business transitions API
  version: 3.0.39
servers:
- url: /v3
security:
- mqAppAndAccessToken: []
tags:
- name: business transitions
paths:
  /businesstransitions:
    post:
      operationId: postBusinesstransitions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessTransitionRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessTransitionResponse'
          description: Success
        '400':
          content: {}
          description: User input error/Bad request
        '409':
          content: {}
          description: Request already processed with a different payload
        '412':
          content: {}
          description: Pre-condition setup issue
        '500':
          content: {}
          description: Server error
      summary: Creates a business transition
      tags:
      - business transitions
  /businesstransitions/business/{business_token}:
    get:
      operationId: getBusinesstransitionsBusinessBusinesstoken
      parameters:
      - description: Business token
        explode: false
        in: path
        name: business_token
        required: true
        schema:
          type: string
        style: simple
      - description: Number of business transitions to retrieve
        explode: true
        in: query
        name: count
        required: false
        schema:
          default: 5
          format: int32
          type: integer
        style: form
      - description: Start index
        explode: true
        in: query
        name: start_index
        required: false
        schema:
          default: 0
          format: int32
          type: integer
        style: form
      - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields.
        explode: true
        in: query
        name: fields
        required: false
        schema:
          type: string
        style: form
      - description: Sort order
        explode: true
        in: query
        name: sort_by
        required: false
        schema:
          default: -id
          type: string
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessTransitionListResponse'
          description: Success
        '400':
          content: {}
          description: Bad request
        '500':
          content: {}
          description: Server error
      summary: Returns transitions for a given business
      tags:
      - business transitions
  /businesstransitions/{token}:
    get:
      operationId: getBusinesstransitionsToken
      parameters:
      - description: Transition token
        explode: false
        in: path
        name: token
        required: true
        schema:
          type: string
        style: simple
      - description: Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields.
        explode: true
        in: query
        name: fields
        required: false
        schema:
          type: string
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessTransitionResponse'
          description: Success
        '400':
          content: {}
          description: Bad request
        '404':
          content: {}
          description: Cardholder not found
        '500':
          content: {}
          description: Server error
      summary: Returns a business transition
      tags:
      - business transitions
components:
  schemas:
    BusinessTransitionResponse:
      properties:
        business_token:
          type: string
        channel:
          enum:
          - API
          - IVR
          - FRAUD
          - ADMIN
          - SYSTEM
          type: string
        created_time:
          format: date-time
          type: string
        created_timestamp:
          format: date-time
          type: string
        last_modified_time:
          format: date-time
          type: string
        metadata:
          additionalProperties:
            type: string
          type: object
        reason:
          type: string
        reason_code:
          enum:
          - '00'
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          - '07'
          - 08
          - 09
          - '10'
          - '11'
          - '12'
          - '13'
          - '14'
          - '15'
          - '16'
          - '17'
          - '18'
          - '19'
          - '20'
          - '21'
          - '22'
          - '23'
          - '24'
          - '25'
          - '26'
          - '27'
          - '28'
          - '29'
          - '30'
          - '31'
          - '32'
          - '86'
          type: string
        status:
          enum:
          - UNVERIFIED
          - LIMITED
          - ACTIVE
          - SUSPENDED
          - CLOSED
          - TERMINATED
          type: string
        token:
          type: string
      required:
      - channel
      - reason_code
      - status
      - token
      type: object
    BusinessTransitionListResponse:
      properties:
        count:
          format: int32
          type: integer
        data:
          items:
            $ref: '#/components/schemas/BusinessTransitionResponse'
          type: array
        end_index:
          format: int32
          type: integer
        is_more:
          default: false
          type: boolean
        start_index:
          format: int32
          type: integer
      type: object
    BusinessTransitionRequest:
      properties:
        business_token:
          type: string
        channel:
          enum:
          - API
          - IVR
          - FRAUD
          - ADMIN
          - SYSTEM
          type: string
        idempotentHash:
          type: string
        reason:
          maxLength: 255
          minLength: 0
          type: string
        reason_code:
          enum:
          - '00'
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          - '07'
          - 08
          - 09
          - '10'
          - '11'
          - '12'
          - '13'
          - '14'
          - '15'
          - '16'
          - '17'
          - '18'
          - '19'
          - '20'
          - '21'
          - '22'
          - '23'
          - '24'
          - '25'
          - '26'
          - '27'
          - '28'
          - '29'
          - '30'
          - '31'
          - '32'
          - '86'
          type: string
        status:
          enum:
          - UNVERIFIED
          - LIMITED
          - ACTIVE
          - SUSPENDED
          - CLOSED
          - TERMINATED
          type: string
        token:
          type: string
      required:
      - business_token
      - channel
      - reason_code
      - status
      type: object
  securitySchemes:
    mqAppAndAccessToken:
      scheme: basic
      type: http