Skip to main content

Perform basic print job.

POST 
/api/web/v1/printers/:printerId/print

Perform basic print job.

Request​

Path Parameters

    printerId stringrequired

    Possible values: Value must match regular expression [a-fA-F0-9-]{32,36}

    The unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3

Body

required

    billing

    object

    segmentId string
    hopper int32

    The printer hopper to use

    magstripe

    object

    back

    object

    coercivity string

    Possible values: [HIGH, LOW]

    Coercivity

    track1 string

    Track 1 data

    track2 string

    Track 2 data

    track3 string

    Track 3 data

    trackType string

    Possible values: [IAT, AAMVA, NTT, PRINTER]

    Track type

    front

    object

    coercivity string

    Possible values: [HIGH, LOW]

    Coercivity

    track1 string

    Track 1 data

    track2 string

    Track 2 data

    track3 string

    Track 3 data

    trackType string

    Possible values: [IAT, AAMVA, NTT, PRINTER]

    Track type

    print

    object

    back

    object[]

    A set of base64 url encoded image (JPEG or PNG) that represents the back side of the card. One image per print layer (e.g. UV, Color, Black) may be provided.

  • Array [

    • data stringrequired

    A base64 url encoded image (JPEG or PNG). For BLACK layer, it is advised to use black and white image with 1bit per pixel and 1013 * 638. Example choose black and white option and set the properties via MS paint.

    enhanceBlackLayer boolean

    The enhanceBlackLayer value defaults as FALSE. To enhance the quality of a black and white or grayscale image that is not 1 bit per pixel, set the enhanceBlackLayer value as TRUE.

    layer string

    Possible values: [COLOR, UV, BLACK, PEEL_OFF, NON_PRINTABLE_GENERIC, NON_PRINTABLE_CHIP, NON_PRINTABLE_MAGSTRIPE, NON_PRINTABLE_SIGNATURE]

  • ]

    • front

    object[]

    A set of base64 url encoded image (JPEG or PNG) that represents the front side of the card. One image per print layer (e.g. UV, Color, Black) may be provided.

  • Array [

    • data stringrequired

    A base64 url encoded image (JPEG or PNG). For BLACK layer, it is advised to use black and white image with 1bit per pixel and 1013 * 638. Example choose black and white option and set the properties via MS paint.

    enhanceBlackLayer boolean

    The enhanceBlackLayer value defaults as FALSE. To enhance the quality of a black and white or grayscale image that is not 1 bit per pixel, set the enhanceBlackLayer value as TRUE.

    layer string

    Possible values: [COLOR, UV, BLACK, PEEL_OFF, NON_PRINTABLE_GENERIC, NON_PRINTABLE_CHIP, NON_PRINTABLE_MAGSTRIPE, NON_PRINTABLE_SIGNATURE]

  • ]

    • printerPreferences

    object

    backOrientation string

    Possible values: [PORTRAIT, LANDSCAPE]

    backRotate180 boolean

    Rotate back side card image 180 degrees?

    barCodesMonochrome boolean

    Print bar codes using monochrome?

    blackPixelsMonochrome boolean

    Print black image pixels using monochrome?

    copies int32

    Possible values: >= 1 and <= 100000

    The number of copies to print

    debow boolean

    Debow card?

    disablePrinting string

    Possible values: [false, ALL, FRONT, BACK]

    frontOrientation string

    Possible values: [PORTRAIT, LANDSCAPE]

    frontRotate180 boolean

    Rotate front side card image 180 degrees?

    inputHopper int32

    Possible values: >= 1 and <= 6

    The input hopper from which to select a card

    lamination

    object

    Lamination option includes laminators for front and back.

    back

    object

    Support for printers with 2 Laminators.

    Laminator1 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    Laminator2 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    front

    object

    Support for printers with 2 Laminators.

    Laminator1 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    Laminator2 string

    Possible values: [DO_NOT_APPLY, APPLY_ONCE, APPLY_TWICE]

    rewrite boolean

    Rewrite card?

    splitRibbon string

    Possible values: [false, YMCT_FRONT_K_BACK, YMC_FRONT_KT_BACK, K_FRONT_YMCT_BACK, YMC_FRONT_K_BACK, K_FRONT_YMC_BACK, K_FRONT_YMCKT_BACK, KT_FRONT_YMCKT_BACK, YMCKTT_FRONT_K_BACK, YMCKFT_FRONT_K_BACK, MTT_FRONT_K_BACK]

    tactileBack string

    Possible values: [true, false, 1, 2, 3]

    tactileFront string

    Possible values: [true, false, 1, 2, 3]

    topcoat boolean

    Topcoat card?

    smartcard

    object

    commands

    object[]

  • Array [

    • command stringrequired

    Possible values: Value must match regular expression [a-fA-F0-9]*|Connect|CONNECT|connect|Disconnect|DISCONNECT|disconnect|Reset|RESET|reset

    resultMatcher string

    Possible values: Value must match regular expression [a-fA-F0-9*]*

    type stringrequired

    Possible values: [APDU, COUPLER]

  • ]

    • multistep boolean

Responses​

Accepted

Schema

    printStatus

    object

    id string

    Possible values: Value must match regular expression [a-fA-F0-9-]{32,36}

    link string
Loading...