Purchase cards in a single request
| Parameter | Type | Required | Description |
|---|---|---|---|
checkout | string | Yes | Must be "condensed" |
| Parameter | Type | Required | Description |
|---|---|---|---|
cards | array | Yes | Cards to purchase (see card object below) |
payment | object | Yes | Payment method and details |
shippingDetails | object | Yes | Shipping address |
billingDetails | object | Depends | Billing address (not required for ACH or DRAWDOWN_ACCOUNT) |
couponCode | string | No | Coupon code to apply to the order |
| Field | Type | Required | Description |
|---|---|---|---|
merchantId | integer | Yes | Merchant ID |
faceValue | number | Yes | Face value of the card |
percentOff | number | Yes | Discount percentage |
type | string | Yes | Card type (ecode, physical, newEcodeB2B, newEcodeAsPre) |
quantity | integer | Yes | Number of cards |
isLowRisk | boolean | No | Set to true to request only cards from trusted sellers. Defaults to any available. |
| Field | Type | Required | Description |
|---|---|---|---|
method | string | Yes | Payment method (see table below) |
details | object | Yes | Payment details (varies by method) |
| Method | Description | Discount |
|---|---|---|
ACH | ACH bank transfer | 2% off order total |
ACH_CREDITCARD | ACH with credit card as backup | 2% off order total |
CREDITCARD | Credit card payment | — |
STORE_CREDIT | Store credit balance | — |
DRAWDOWN_ACCOUNT | Drawdown account balance (Elite partners only) | 2.5% off order total |
| Field | Type | Description |
|---|---|---|
id | number | Saved bank account ID from payment methods |
| Field | Type | Description |
|---|---|---|
creditCardId | number | Saved credit card ID from payment methods |
ACH_CREDITCARD)| Field | Type | Description |
|---|---|---|
id | number | Saved bank account ID |
creditCardDetails.creditCardId | number | Saved credit card ID for backup |
details object required — the system debits the account directly.
details object required — applied automatically from account balance.
| Field | Type | Required | Description |
|---|---|---|---|
firstname | string | Yes | First name |
lastname | string | Yes | Last name |
street | string | Yes | Street address |
street2 | string | No | Apartment, suite, etc. |
city | string | Yes | City |
state | string | Yes | State (2-letter code) |
postcode | string | Yes | ZIP code |
company | string | No | Company name |
| Error | Cause |
|---|---|
"Not all requested cards were added to the cart" | Insufficient inventory for the requested cards |
"Insufficient funds" | Payment failed |
"payment method not setup" | Invalid payment method string |
GET /v3/orders/:orderId to track fulfillment