Simulate Card Order Fulfillment

1. A Highnote account
2. An API key or the API Explorer
3. An individual card order or group card order

Warning: The Highnote test environment lets you explore the platform features and functionality freely. It is intended for experimenting, building integrations, and training your team.

To ensure the security of your real-world data, please do not use production data in the test environment. Production data includes sensitive information like customer details, financial data, or personally identifiable information (PII).

Use only dummy or test data explicitly created for testing purposes in the test environment.

Highnote offers simulations for individual and group physical card order fulfillment. In the test environment, physical card orders are not physically shipped. You can use these simulations to test the following:

• Your card product's physical card order flow
• Notification events

This guide provides steps for simulating physical card order fulfillment for individual and group card orders.

When any type of card order is placed, the order follows the following sequence:

1. Card order is sent to the printer.
2. The shipment is approved.
3. The card order is shipped.
4. Optional - The card order fails.

You can use the Highnote API to update the status of a physical card order and simulate the card order lifecycle to test your integration.

Use the following sections to simulate an individual card order.

Once you have created a physical card order with a status of NEW, you can transition it to SENT_TO_PRINTER.

Use the following mutation to simulate sending a physical payment card order to the printer:

Once a physical card order has been SENT_TO_PRINTER, you can approve the order and change the status to APPROVED.

Use the following mutation to simulate approving a physical payment card order:

Orders with a status of APPROVED may be transitioned to SHIPPED and will return the shipping method, and if available, tracking number.

Use the following mutation to simulate shipping a physical payment card order:

To design your system to handle failed shipments, you can simulate a status of SHIP_FAILED.

Use the following mutation to simulate a failed shipment:

You can simulate group order fulfillment in the test environment without actually shipping cards. This is useful for simulating group order statuses and notifications.

You can use the mutations provided in this guide to create and complete a group order. A completed order will have a status of PENDING.

Use the following mutation to transition the group order to SENT_TO_PRINTER status:

Once the group order has been SENT_TO_PRINTER, you can change the status to APPROVED using the following mutation:

Note: For an overview of group order shipping methods, see Shipping Methods.

After a group order is approved, you can use the following mutation to transition to the SHIPPED status. The shipping method and tracking number (if available) will be returned in the response payload:

To design your system to handle failed Group Order shipments, you can simulate a status of SHIP_FAILED.

To automate your integration, use the following notification events:

• Physical card fulfillment: Use this notification event to stay notified when an individual card order ships or fails
• Physical card group order: Use this notification to stay notified when a physical card group order ships or fails

The details provided in the payloads from these events can be used for the following use cases:

• Automate your application or website's card order fulfillment workflows
• Create account holder notifications and alerts
• Create status views for card orders in your application or website