Imprint Payments, Inc

Imprint Docs

Get Started

Authentication

Imprint UUIDs

Pagination

Amount Representation

Error Handling

Sandbox Test Data

Application SDK

Android

Auth API

Authentication API generated an authentication token
The token is generated from the API token and a customer ID that identifies the customer in the Partner system
The token will only be valid to request for resources associated to the customer identified by the customer identifier

Post Auth

Cards API

List Cards API returns the cards for the product account based on the query
Customers can have at max one virtual card and one physical card
By default the API does not return the card CVV, to request for the CVV set show_cvv query parameter to true

List Cards

Rewards API

Put Reservation API creates a reservation in the Imprint system
A new reservation is created if a reservation with the reservationDetail.orderID is not found in the Imprint system
else the reservation matching the reservationDetail.orderID is updated.
All modifications and cancellation to a reservation needs to be communicated via this API.
This API supports reservations with one or multiple verticals.

Put Reservation

Get Balance API returns the pending and available rewards balance for the requested product account

Get Balance

Servicing API

List Transactions

List Events

Put Event

Webhooks

Provide a webhook endpoint to receive notification about application status transitions
The request represents data Imprint will post to your webhook endpoint
Imprint expects a 200 OK response to acknowledge the receipt of the notification

Application Notification

Provide a webhook endpoint to receive notification about card status transitions
The request represents data Imprint will post to your webhook endpoint
Imprint expects a 200 OK response to acknowledge the receipt of the notification

Card Notification

Transaction Notification

Default

Imprint Partner APIs-clone

Production

Sandbox

<p class="slate-p " ><strong class="slate-bold">Welcome. </strong>The Imprint API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.</p><p class="slate-p " ></p><div class=card-box style="width:60%; min-width:540px;"><div ><p class="slate-p " ><span style="color:#666666"><strong class="slate-bold">Production</strong></span></p><p class="slate-p " >https://api.imprint.co/partners</p><p class="slate-p " ><span style="color:#666666"><strong class="slate-bold">Sandbox</strong></span></p><p class="slate-p " >https://api-sandbox.imprint.co/partners</p></div></div><p class="slate-p " ></p><p class="slate-p " >Want to get in touch with the Imprint team? Reach out to us via email (<a href="mailto:dev-support@imprint.co" target="_self">dev-support@imprint.co</a>) with any questions or to request sandbox credentials. We’re here to help!</p><p class="slate-p " ></p>

The Imprint API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Want to get in touch with the Imprint team? Reach out to us via email (

) with any questions or to request sandbox credentials. We’re here to help!

<p class="slate-p " >Authentication to Imprint APIs is performed via <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#bearer" target="">Bearer Auth</a>, using the <code class="slate-code">Authorization</code> request header.  Your Imprint team will provide an API Key for each environment (i.e. Sandbox, Production), and we ask that you store these securely. For example, please do not expose your API Key anywhere that&apos;s publicly accessible, such as GitHub, client-side code (code that will be sent to a user&apos;s browser or app), etc. </p><p class="slate-p " >Further, all API requests must be made over HTTPS. Calls made over plain HTTP will fail.</p><p class="slate-p " ></p>

Authentication to Imprint APIs is performed via 

 request header.  Your Imprint team will provide an API Key for each environment (i.e. Sandbox, Production), and we ask that you store these securely. For example, please do not expose your API Key anywhere that's publicly accessible, such as GitHub, client-side code (code that will be sent to a user's browser or app), etc. 

Further, all API requests must be made over HTTPS. Calls made over plain HTTP will fail.

<p class="slate-p " >Imprint uses UUIDs with relevant prefixes to identify an entity. The format is <code class="slate-code">{entity_abbreviation}-{version}-{uuid}</code></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ENTITY</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ABBREVIATION</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">EXAMPLE</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Transaction</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TRXN</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TRXN-v1-xxxxx</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Accountholder</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ACTH</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ACTH-v1-xxxxx</p></td></div></tr></tbody></table></div><p class="slate-p " ><em class="slate-italic">For simplicity, we use </em><em class="slate-italic"><code class="slate-code">xxxxxx</code></em><em class="slate-italic"> to represent a UUID in these docs.</em></p><p class="slate-p " ></p>

Imprint uses UUIDs with relevant prefixes to identify an entity. The format is 

Title

Description

<p class="slate-p " >Imprint provides List APIs for most entities. To manage large payloads, these APIs support pagination.</p><p class="slate-p " >At a minimum, List APIs take the following optional parameters: <code class="slate-code">limit</code>, <code class="slate-code">starting_after</code>, and <code class="slate-code">ending_before</code>.</p><p class="slate-p " >Both <code class="slate-code">starting_after</code> and <code class="slate-code">ending_before</code> take an existing object ID value. The <code class="slate-code">ending_before</code> parameter returns objects before the specified object, while the <code class="slate-code">starting_after</code> parameter returns objects after the specified object. You cannot pass both parameters at the same time.</p><p class="slate-p " ></p>

Imprint provides List APIs for most entities. To manage large payloads, these APIs support pagination.

At a minimum, List APIs take the following optional parameters: 

 parameter returns objects before the specified object, while the 

 parameter returns objects after the specified object. You cannot pass both parameters at the same time.

<p class="slate-p " >Imprint APIs avoid using float values to eliminate precision loss during calculations. Instead, we represent these values through a combination of two integer fields:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">exponent</code>: the number of decimal places to consider when converting the value to a float</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">value</code>: the value of the amount in the smallest unit of the currency (e.g., cents for USD)</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">currency</code>: an optional ISO-4217 currency code (assumes USD)</div></li></ul><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">EXAMPLE AMOUNT</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">REPRESENTATION</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">CONVERSION TO FLOAT</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >$14.52 purchase amount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">{ &quot;exponent&quot;: 2, &quot;value&quot;: 1452 }</code>	</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Divide <code class="slate-code">value</code> by 10^(<code class="slate-code">exponent</code>), so <code class="slate-code">1452/100 = 14.52</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >15.24% APR</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">{ &quot;exponent&quot;: 4, &quot;value&quot;: 1524 }</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Divide <code class="slate-code">value</code> by 10^(<code class="slate-code">exponent</code>), so <code class="slate-code">1524/10000 = 0.1524</code></p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

Imprint APIs avoid using float values to eliminate precision loss during calculations. Instead, we represent these values through a combination of two integer fields:

<h3 class="slate-h3 " >APIs</h3><p class="slate-p " >Imprint uses standard HTTP codes to indicate the success or failure of a request. In general, codes in the <code class="slate-code">2xx</code> range indicate success, and codes in the <code class="slate-code">4xx</code> range indicate an error.</p><p class="slate-p " >Additionally, Imprint works with partners to pre-define a list of customized error codes that can be handled programmatically by the client.</p><p class="slate-p " >The following is an example error payload Imprint may return:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language- keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">    “message”: “Something went wrong”,</div><div class="slate-code_line">    “code”: “101&quot;</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " >Clients can decode these alternative error codes and handle them as needed.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Webhooks</h3><p class="slate-p " >Please acknowledge that your system has received the webhook event by sending Imprint a <code class="slate-code">200</code> response. Any response other than <code class="slate-code">200</code> is considered an error response and indicates that your system did not receive the webhook.</p><p class="slate-p " >If your system responds with an error or fails to respond, Imprint will retry sending the webhook with an exponential backoff retry policy. Imprint will re-attempt to send the webhook up to 10 tries following the retry interval.</p><p class="slate-p " ></p>

Imprint uses standard HTTP codes to indicate the success or failure of a request. In general, codes in the 

 range indicate success, and codes in the 

Additionally, Imprint works with partners to pre-define a list of customized error codes that can be handled programmatically by the client.

The following is an example error payload Imprint may return:

Clients can decode these alternative error codes and handle them as needed.

Please acknowledge that your system has received the webhook event by sending Imprint a 

 is considered an error response and indicates that your system did not receive the webhook.

If your system responds with an error or fails to respond, Imprint will retry sending the webhook with an exponential backoff retry policy. Imprint will re-attempt to send the webhook up to 10 tries following the retry interval.

<h3 class="slate-h3 " >This document contains sample data you can use for testing your integration in the Imprint sandbox</h3><p class="slate-p " ></p><h3 class="slate-h3 " >Application Phone Number</h3><p class="slate-p " >In all environments, Imprint retains application information associated with each phone number and allows the applicant to resume their application at any stage. For example, if you complete an application using <code class="slate-code">(111)-111-1111</code> and it is approved, any subsequent application attempt using this phone number will automatically start at the offer acceptance stage. If you would like to complete a brand-new application, please use a phone number that does not have an active application. </p><p class="slate-p " >You will be able to tell that there is an active application associated with the phone number as Imprint will immediately prompt with this screen: </p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/2596f84d-fc33-4e9e-85fe-3d32101ea5a8.jpg" style="
              width:511px;
	            height:296px;
	            aspect-ratio:511 / 296"
         /></div><h3 class="slate-h3 " >Force Application Outcome</h3><p class="slate-p " >When entering your application details, please modify the “Last Name” value to trigger certain application states:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">VALUE ENTERED IN “LEGAL LAST NAME”</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">CORRESPONDING APPLICATION STATE</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">approve</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">APPROVED</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">review</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">ACTION_REQUIRED</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">frozen</code></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">ACTION_REQUIRED</code></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><em class="slate-italic">Anything Else</em></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><code class="slate-code">REJECTED</code></p></td></div></tr></tbody></table></div><p class="slate-p " >Please note that these values are <strong class="slate-bold">case-sensitive</strong>. For example, the following will trigger an approved application:</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/7f4b16f8-34f7-4b9f-8e42-112678e61efc.jpg" style="
              width:318px;
	            height:232px;
	            aspect-ratio:318 / 232"
         /></div><h3 class="slate-h3 " >Verify Phone Number with One Time Password</h3><p class="slate-p " >Imprint does not send one-time-passwords in the Sandbox environment. When prompted to verify your phone number, please enter <code class="slate-code">888888</code>, no other values will be accepted. </p><p class="slate-p " ></p>

This document contains sample data you can use for testing your integration in the Imprint sandbox

In all environments, Imprint retains application information associated with each phone number and allows the applicant to resume their application at any stage. For example, if you complete an application using 

 and it is approved, any subsequent application attempt using this phone number will automatically start at the offer acceptance stage. If you would like to complete a brand-new application, please use a phone number that does not have an active application. 

You will be able to tell that there is an active application associated with the phone number as Imprint will immediately prompt with this screen: 

When entering your application details, please modify the “Last Name” value to trigger certain application states:

. For example, the following will trigger an approved application:

Verify Phone Number with One Time Password

Imprint does not send one-time-passwords in the Sandbox environment. When prompted to verify your phone number, please enter 

<h4>Imprint enables program partners to implement the card application directly into their channels using Web or Native Mobile SDKs. Imprint hosts the entire application experience and functionality through these drop-in components, eliminating the need for a customer to visit a separate website or download an app to complete their card application.</h4><p></p>

Imprint enables program partners to implement the card application directly into their channels using Web or Native Mobile SDKs. Imprint hosts the entire application experience and functionality through these drop-in components, eliminating the need for a customer to visit a separate website or download an app to complete their card application.

<h4>APIs to retrieve data on customer transactions, and transaction events matching reservations, and manually match an event to a reservation. The transaction list can be used by customer support teams to retrieve transaction information to manually judge whether a transaction should match a reward.</h4><p></p>

APIs to retrieve data on customer transactions, and transaction events matching reservations, and manually match an event to a reservation. The transaction list can be used by customer support teams to retrieve transaction information to manually judge whether a transaction should match a reward.