openapi: 3.0.2 paths: /terminals/fiserv/ping: post: summary: /terminals/fiserv/ping tags: - Terminals parameters: [] operationId: ping requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string required: - hsn responses: '200': description: '200' content: application/json: schema: type: object properties: connected: type: boolean required: - connected '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/list_terminals: post: summary: /terminals/fiserv/list_terminals tags: - Terminals parameters: [] operationId: listTerminals responses: '200': description: '200' content: application/json: schema: type: object properties: terminals: type: array items: type: string required: - terminals '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/terminal_details: post: summary: /terminals/fiserv/terminal_details tags: - Terminals parameters: [] operationId: terminalDetails responses: '200': description: '200' content: application/json: schema: type: object properties: terminal_details: type: array items: type: object properties: hsn: type: string name: type: string connected: type: boolean device_type: type: string environment: type: string device_capabilities: type: object properties: screen_dimension_x: type: number screen_dimension_y: type: number pin_pad: type: boolean msr: type: boolean emv: type: boolean nfc: type: boolean signature: type: boolean printer: type: boolean required: - screen_dimension_x - screen_dimension_y - pin_pad - msr - emv - nfc - signature - printer required: - hsn - name - connected - device_type - environment - device_capabilities required: - terminal_details '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/date_time: post: summary: /terminals/fiserv/date_time tags: - Terminals parameters: [] operationId: dateTime requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string date_time: type: string required: - hsn - date_time responses: '200': description: '200' content: application/json: schema: type: object properties: date_time: type: string required: - date_time '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/get_pan_pad_version: post: summary: /terminals/fiserv/get_pan_pad_version tags: - Terminals parameters: - name: x-session-key in: header required: true schema: type: string operationId: getPanPadVersion requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string required: - hsn responses: '200': description: '200' content: application/json: schema: type: object properties: version: type: string required: - version '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/connect: post: summary: /terminals/fiserv/connect tags: - Terminals parameters: [] operationId: connect requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string force: type: boolean required: - hsn responses: '200': description: '200' content: application/json: schema: type: object properties: key: type: string expires: type: string required: - key - expires '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/disconnect: post: summary: /terminals/fiserv/disconnect tags: - Terminals parameters: - name: x-session-key in: header required: true schema: type: string operationId: disconnect requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string required: - hsn responses: '200': description: '200' content: application/json: schema: type: object properties: disconnected: type: boolean required: - disconnected '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/display: post: summary: /terminals/fiserv/display tags: - Terminals parameters: - name: x-session-key in: header required: true schema: type: string operationId: display requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string text: type: string required: - hsn - text responses: '200': description: '200' content: application/json: schema: type: object properties: text: type: string required: - text '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/clear_display: post: summary: /terminals/fiserv/clear_display tags: - Terminals parameters: - name: x-session-key in: header required: true schema: type: string operationId: clearDisplay requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string required: - hsn responses: '200': description: '200' content: application/json: schema: type: object properties: cleared: type: boolean required: - cleared '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/read_confirmation: post: summary: /terminals/fiserv/read_confirmation tags: - Terminals parameters: [] operationId: readConfirmation requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string prompt: type: string beep: type: boolean required: - hsn - prompt responses: '200': description: '200' content: application/json: schema: type: object properties: confirmed: type: boolean required: - confirmed '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/read_input: post: summary: /terminals/fiserv/read_input tags: - Terminals parameters: - name: x-session-key in: header required: true schema: type: string operationId: readInput requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string prompt: type: string format: oneOf: - type: string enum: - PHONE - type: string enum: - AMOUNT - type: string enum: - MMYY - type: string pattern: ^N\d+(,\d{1,2})?$ - type: string pattern: ^AN\d+(,\d{1,2})?$ beep: type: boolean required: - hsn - prompt - format responses: '200': description: '200' content: application/json: schema: type: object properties: input: type: string required: - input '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/read_signature: post: summary: /terminals/fiserv/read_signature tags: - Terminals parameters: [] operationId: readSignature requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string prompt: type: string gzip_signature: type: string enum: - 'true' - 'false' signature_format: type: string enum: - png - bmp - jpg signature_image_type: type: string enum: - binary - rgb signature_dimensions: type: string pattern: ^\d+,\d+$ required: - hsn - prompt responses: '200': description: '200' content: application/json: schema: type: object properties: signature: type: string required: - signature '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/cancel: post: summary: /terminals/fiserv/cancel tags: - Terminals parameters: [] operationId: cancel requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string required: - hsn responses: '200': description: '200' content: application/json: schema: type: object properties: cancelled: type: boolean required: - cancelled '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/print_receipt: post: summary: /terminals/fiserv/print_receipt tags: - Terminals parameters: [] operationId: printReceipt requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string print_extra_receipt: type: boolean print_delay: type: integer payment_id: type: string required: - hsn - payment_id responses: '200': description: '200' content: application/json: schema: type: object properties: receipt_data: type: object properties: dba: type: string address1: type: string address2: type: string phone: type: string header: type: string order_note: type: string date_time: type: string items: type: string name_on_card: type: string footer: type: string required: - receipt_data '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/read_card: post: summary: /terminals/fiserv/read_card tags: - Terminals parameters: [] operationId: readCard requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string amount: type: integer include_amount_display: type: boolean confirm_amount: type: boolean include_signature: type: boolean signature_format: type: string enum: - png - bmp - jpg gzip_signature: type: boolean signature_dimensions: type: string pattern: ^\d+,\d+$ signature_image_type: type: string enum: - binary - rgb beep: type: boolean aid: type: string enum: - debit - credit include_pin: type: boolean required: - hsn - amount responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string entity: type: string enum: - payment_method created_at: type: string updated_at: type: string payment_method_type: type: string enum: - card - bank source_type: type: string enum: - cardpointe - external - none - plaid - grailpay billing_details: type: object properties: name: type: string card: type: object properties: last_four_digits: type: string brand: type: string enum: - visa - mastercard - american_express - discover exp_month: type: string exp_year: type: string reuse_eligible: type: boolean required: - last_four_digits - brand signature: type: string single_use_token: type: boolean required: - id - entity - created_at - updated_at - payment_method_type - source_type '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/read_manual: post: summary: /terminals/fiserv/read_manual tags: - Terminals parameters: [] operationId: readManual requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string amount: type: integer include_signature: type: boolean signature_format: type: string enum: - png - bmp - jpg gzip_signature: type: boolean signature_dimensions: type: string pattern: ^\d+,\d+$ signature_image_type: type: string enum: - binary - rgb include_expiration_date: type: boolean beep: type: boolean required: - hsn - amount responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string entity: type: string enum: - payment_method created_at: type: string updated_at: type: string payment_method_type: type: string enum: - card - bank source_type: type: string enum: - cardpointe - external - none - plaid - grailpay card: type: object properties: last_four_digits: type: string brand: type: string enum: - visa - mastercard - american_express - discover exp_month: type: string exp_year: type: string reuse_eligible: type: boolean required: - last_four_digits - brand single_use_token: type: boolean required: - id - entity - created_at - updated_at - payment_method_type - source_type '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/auth_card: post: summary: /terminals/fiserv/auth_card tags: - Terminals parameters: [] operationId: authCard requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string aid: type: string enum: - debit - credit auth_code: type: string bin: type: string print_receipt: type: boolean include_signature: type: boolean include_amount_display: type: boolean beep: type: boolean include_avs: type: boolean include_pin: type: boolean gzip_signature: type: boolean clear_display_delay: type: integer print_delay: type: integer print_extra_receipt: type: boolean signature_dimensions: type: string pattern: ^\d+,\d+$ signature_format: type: string enum: - png - bmp - jpg signature_image_type: type: string enum: - binary - rgb confirm_amount: type: boolean payment_intent_id: type: string minLength: 1 description: Payment Intent ID receipt_header: type: string receipt_footer: type: string receipt_dba: type: string receipt_phone: type: string receipt_address1: type: string receipt_address2: type: string required: - hsn - payment_intent_id responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string entity: type: string enum: - payment status: type: string enum: - pending - uncaptured - captured - failed - voided - cancelled billing_details: nullable: true amount: type: integer minimum: 0 exclusiveMinimum: 0 amount_authorized: type: integer nullable: true amount_captured: type: integer nullable: true amount_refunded: type: integer nullable: true amount_voided: type: integer nullable: true amount_disputed: type: integer nullable: true amount_reversed: type: integer nullable: true cvv: type: string enum: - M - 'N' - P - S - U - X - '' avs: type: string enum: - A - Z - W - P - 'Y' - X - F - D - 'N' - R - S - U - G - '' address_line1_check: type: string enum: - pass - fail - unavailable - unchecked address_postal_code_check: type: string enum: - pass - fail - unavailable - unchecked cvv_check: type: string enum: - pass - fail - unavailable entry_mode: type: string enum: - keyed - moto - ecommerce - recurring - swipe_non_emv - digital_wallet - emv_contact - contactless - fallback_to_track - fallback_to_keyed - unknown reversed: type: boolean reversal_id: type: string disputed: type: boolean dispute_id: type: string payment_intent_id: type: string payment_method_id: type: string payment_method: type: object properties: id: type: string entity: type: string enum: - payment_method created_at: type: string updated_at: type: string payment_method_type: type: string enum: - card - bank source_type: type: string enum: - cardpointe - external - none - plaid - grailpay billing_details: type: object properties: name: type: string card: type: object properties: last_four_digits: type: string brand: type: string enum: - visa - mastercard - american_express - discover exp_month: type: string exp_year: type: string reuse_eligible: type: boolean required: - last_four_digits - brand signature: type: string single_use_token: type: boolean required: - id - entity - created_at - updated_at - payment_method_type - source_type auth_code: type: string auth_response_text: type: string external: type: boolean card_present: type: boolean created_at: type: string updated_at: type: string account_id: type: string reference_id: type: string user_fields: type: object additionalProperties: nullable: true description: type: string settlement_status: type: string enum: - settled - unsettled settled_at: type: string terminal_details: type: object properties: entry_mode: type: string enum: - keyed - moto - ecommerce - recurring - swipe_non_emv - digital_wallet - emv_contact - contactless - fallback_to_track - fallback_to_keyed - unknown signature: type: object properties: data: type: string gzipped: type: boolean image_type: type: string enum: - binary - rgb format: type: string enum: - png - jpg - bmp dimensions: type: object properties: width: type: number height: type: number required: - width - height required: - data emv_tag_data: type: string receipt_data: type: object properties: dba: type: string address_1: type: string address_2: type: string phone: type: string header: type: string order_note: type: string date_time: type: string items: type: string name_on_card: type: string footer: type: string required: - entry_mode required: - id - entity - status - amount - amount_authorized - amount_captured - amount_refunded - amount_voided - amount_disputed - amount_reversed - payment_intent_id - payment_method_id - payment_method - created_at - updated_at - account_id - terminal_details '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/auth_manual: post: summary: /terminals/fiserv/auth_manual tags: - Terminals parameters: [] operationId: authManual requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string auth_code: type: string print_receipt: type: boolean include_signature: type: boolean include_amount_display: type: boolean beep: type: boolean include_avs: type: boolean include_cvv: type: boolean gzip_signature: type: boolean clear_display_delay: type: integer print_delay: type: integer print_extra_receipt: type: boolean signature_dimensions: type: string pattern: ^\d+,\d+$ signature_format: type: string enum: - png - bmp - jpg signature_image_type: type: string enum: - binary - rgb payment_intent_id: type: string minLength: 1 description: Payment Intent ID receipt_header: type: string receipt_footer: type: string receipt_dba: type: string receipt_phone: type: string receipt_address1: type: string receipt_address2: type: string required: - hsn - payment_intent_id responses: '200': description: '200' content: application/json: schema: type: object properties: id: type: string entity: type: string enum: - payment status: type: string enum: - pending - uncaptured - captured - failed - voided - cancelled billing_details: nullable: true amount: type: integer minimum: 0 exclusiveMinimum: 0 amount_authorized: type: integer nullable: true amount_captured: type: integer nullable: true amount_refunded: type: integer nullable: true amount_voided: type: integer nullable: true amount_disputed: type: integer nullable: true amount_reversed: type: integer nullable: true cvv: type: string enum: - M - 'N' - P - S - U - X - '' avs: type: string enum: - A - Z - W - P - 'Y' - X - F - D - 'N' - R - S - U - G - '' address_line1_check: type: string enum: - pass - fail - unavailable - unchecked address_postal_code_check: type: string enum: - pass - fail - unavailable - unchecked cvv_check: type: string enum: - pass - fail - unavailable entry_mode: type: string enum: - keyed - moto - ecommerce - recurring - swipe_non_emv - digital_wallet - emv_contact - contactless - fallback_to_track - fallback_to_keyed - unknown reversed: type: boolean reversal_id: type: string disputed: type: boolean dispute_id: type: string payment_intent_id: type: string payment_method_id: type: string payment_method: type: object properties: id: type: string entity: type: string enum: - payment_method created_at: type: string updated_at: type: string payment_method_type: type: string enum: - card - bank source_type: type: string enum: - cardpointe - external - none - plaid - grailpay billing_details: type: object properties: name: type: string card: type: object properties: last_four_digits: type: string brand: type: string enum: - visa - mastercard - american_express - discover exp_month: type: string exp_year: type: string reuse_eligible: type: boolean required: - last_four_digits - brand signature: type: string single_use_token: type: boolean required: - id - entity - created_at - updated_at - payment_method_type - source_type auth_code: type: string auth_response_text: type: string external: type: boolean card_present: type: boolean created_at: type: string updated_at: type: string account_id: type: string reference_id: type: string user_fields: type: object additionalProperties: nullable: true description: type: string settlement_status: type: string enum: - settled - unsettled settled_at: type: string terminal_details: type: object properties: entry_mode: type: string enum: - keyed - moto - ecommerce - recurring - swipe_non_emv - digital_wallet - emv_contact - contactless - fallback_to_track - fallback_to_keyed - unknown signature: type: object properties: data: type: string gzipped: type: boolean image_type: type: string enum: - binary - rgb format: type: string enum: - png - jpg - bmp dimensions: type: object properties: width: type: number height: type: number required: - width - height required: - data emv_tag_data: type: string receipt_data: type: object properties: dba: type: string address_1: type: string address_2: type: string phone: type: string header: type: string order_note: type: string date_time: type: string items: type: string name_on_card: type: string footer: type: string required: - entry_mode required: - id - entity - status - amount - amount_authorized - amount_captured - amount_refunded - amount_voided - amount_disputed - amount_reversed - payment_intent_id - payment_method_id - payment_method - created_at - updated_at - account_id - terminal_details '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/tip: post: summary: /terminals/fiserv/tip tags: - Terminals parameters: [] operationId: tip requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string prompt: type: string amount: type: integer include_custom_tip_amount: type: boolean tip_percent_presets: type: array items: type: integer required: - hsn - prompt - amount responses: '200': description: '200' content: application/json: schema: type: object properties: tip: type: string amount: type: string total: type: string required: - tip - amount - total '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance /terminals/fiserv/activation_code: post: summary: /terminals/fiserv/activation_code tags: - Terminals parameters: [] operationId: activationCode requestBody: description: Body content: application/json: schema: type: object properties: hsn: type: string required: - hsn responses: '200': description: '200' content: application/json: schema: type: object properties: activation_code: type: string required: - activation_code '400': description: '400' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '401': description: '401' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '403': description: '403' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance '500': description: '500' content: application/json: schema: type: object properties: type: type: string enum: - BAD_REQUEST - NOT_FOUND - PAYMENT_CREATE_ERROR - PAYMENT_INTENT_INVALID_STATUS - PAYMENT_METHOD_CREATE_ERROR - TERMINAL_ERROR - TERMINAL_NOT_FOUND_ERROR - TERMINAL_UNAUTHORIZED_ERROR - TERMINAL_UNKNOWN_ERROR title: type: string detail: type: string status: type: integer instance: type: string errors: type: array items: type: object properties: code: type: string expected: type: string message: type: string path: type: array items: oneOf: - type: string - type: number received: type: string required: - code - message - path nullable: true required: - type - title - status - instance info: title: Terminals API version: 1.0.1 description: > Welcome to the Terminals API documentation!

Introduction

This is the reference documentation and schemas for the Residuals API.

Authentication

The platform uses API Keys to manage access to the API. You can pass the API key in the `x-api-key` header to the request.

Talk you your sales rep about acquiring these API keys.

Authorization is done via headers. You should pass the api key as the value to the `x-api-key` header. For example, `x-api-key: ${API_KEY}`.

Please note that you will be given 2 API keys, one public key and one private key. Use the private key for all server to server communication.

The public key is used for interfacing wih the JS SDK. components: {}