Skip to main content
POST
/
v2
/
transaction_intents
Create a transaction intent
curl --request POST \
  --url https://dev.sbx.imprint.co/v2/transaction_intents \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "F9B5A5E8-C8B0-4B7A-8E6B-0C8EE90A62CF",
  "payment_method_id": "<string>",
  "amount": 10000,
  "currency": "USD",
  "network_transaction_id": "<string>",
  "merchant_name": "walmart",
  "merchant_address": {
    "street_line1": "123 Main St",
    "street_line2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "USA"
  },
  "merchant_id": "<string>",
  "merchant_code": "<string>",
  "expected_date": "2025-02-13T19:08:07.000Z",
  "metadata": {
    "platform_version": "2.1.0"
  }
}
'
{
  "id": "5B30532B-5B5B-4826-8DE2-429C57B705FD",
  "customer_id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
  "payment_method_id": "DCBFC736-2286-42DD-897D-160DCA80AED2",
  "amount": 10000,
  "currency": "USD",
  "status": "CONFIRMED",
  "network_transaction_id": "<string>",
  "partner_transaction_id": "<string>",
  "created_at": "2025-02-13T19:08:07.000Z",
  "updated_at": "2025-02-13T19:08:07.000Z",
  "metadata": {
    "platform_version": "2.1.0"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Body

application/json
​
customer_id
string
required

The Imprint Customer ID of the customer making the transaction intent

Example:

"F9B5A5E8-C8B0-4B7A-8E6B-0C8EE90A62CF"

​
amount
integer
required

Amount in min units.

Example:

10000

​
currency
string
required

The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")

Example:

"USD"

​
payment_method_id
string
​
network_transaction_id
string

The network's unique identifier for the transaction. Examples include Visa Transaction ID, Mastercard Trace ID, and American Express Network Reference ID

​
merchant_name
string

The name of the merchant this transaction intent will be

Example:

"walmart"

​
merchant_address
object

Mailing address information

​
merchant_id
string
​
merchant_code
string
​
expected_date
string

the RFC-3339 date when the transaction is expected to process. This does not have to be exact but it will be used as a data point to help link a transaction with a transaction intent. This example includes date and time to be explict, any RFC3339 date or date+time will be accepted

Example:

"2025-02-13T19:08:07.000Z"

​
metadata
object
Example:
{ "platform_version": "2.1.0" }

Response

Transaction intent created successfully

​
id
string
required
Example:

"5B30532B-5B5B-4826-8DE2-429C57B705FD"

​
customer_id
string
required
Example:

"9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4"

​
amount
integer
required

Currency amount

Example:

10000

​
currency
string
required

The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")

Example:

"USD"

​
status
enum<string>
required
Available options:
CONFIRMED,
CANCELED
Example:

"CONFIRMED"

​
created_at
string
required

the RFC-3339 timestamp when the transaction intent was created

Example:

"2025-02-13T19:08:07.000Z"

​
payment_method_id
string

The payment_method_id that this transaction_intent was executed with.

Example:

"DCBFC736-2286-42DD-897D-160DCA80AED2"

​
network_transaction_id
string

The network's unique identifier for the transaction. Examples include Visa Transaction ID, Mastercard Trace ID, and American Express Network Reference ID

​
partner_transaction_id
string

The partner's unique transaction id

​
updated_at
string

the RFC-3339 timestamp when the transaction intent was last updated

Example:

"2025-02-13T19:08:07.000Z"

​
metadata
object

Additional transaction intent data

Example:
{ "platform_version": "2.1.0" }