Create and process a factoring decline order

post

https://api.example.com/orders

Creates an order and immediately charges the supplied credit card.

Inspect response_code in the response body to determine whether the charge was successful or declined by the processor.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

connection_id

integer

enum

required

Billing connection assigned during onboarding. Always send 1 unless instructed otherwise.

Allowed:

campaign_id

integer

required

≥ 1

Campaign the order belongs to. Provided during onboarding.

route_id

integer

enum

required

Currency route identifier. Send the route that matches the order currency:

1 - USD, US Dollar
3 - EUR, Euro
4 - GBP, Pound Sterling
5 - CAD, Canadian Dollar
6 - AUD, Australian Dollar
7 - NZD, New Zealand Dollar
8 - DKK, Danish Krone
9 - SEK, Swedish Krona
10 - NOK, Norwegian Krone

action

string

enum

required

Charges the card immediately. Always send process.

Allowed:

offers

array of objects

required

length ≥ 1

Non-empty list of order offers.

offers*

string

required

Customer email address.

phone

string

Customer phone number.

birthday

date

Customer date of birth in YYYY-MM-DD format.

gender

string

length ≤ 32

Customer gender.

ship_fname

string

required

length ≤ 255

Shipping first name.

ship_lname

string

required

length ≤ 255

Shipping last name.

ship_address1

string

required

length ≤ 255

Shipping street address, line 1.

ship_address2

string

length ≤ 255

Shipping street address, line 2.

ship_city

string

required

length ≤ 255

Shipping city.

ship_state

string

length between 2 and 20

Shipping state or province. Required for US and CA addresses.

ship_zipcode

string

required

length between 3 and 15

Shipping postal code.

ship_country

string

required

length between 2 and 2

^[A-Z]{2}$

Shipping country code in ISO 3166-1 alpha-2 format.

ship_organization

string

length ≤ 255

Shipping organization or company name.

same_address

boolean

required

Send true to reuse the shipping address as billing. If false, also send the bill_* fields.

bill_fname

string

length ≤ 255

Billing first name. Required when same_address is false.

bill_lname

string

length ≤ 255

Billing last name. Required when same_address is false.

bill_phone

string

Billing phone number.

bill_address1

string

length ≤ 255

Billing street address, line 1. Required when same_address is false.

bill_address2

string

length ≤ 255

Billing street address, line 2.

bill_city

string

length ≤ 255

Billing city. Required when same_address is false.

bill_state

string

length between 2 and 20

Billing state or province. Required for US and CA billing addresses when same_address is false.

bill_zipcode

string

length between 3 and 15

Billing postal code. Required when same_address is false.

bill_country

string

length between 2 and 2

^[A-Z]{2}$

Billing country code in ISO 3166-1 alpha-2 format. Required when same_address is false.

bill_organization

string

length ≤ 255

Billing organization or company name.

payment_method_id

integer

enum

required

Credit card payment method. Always send 1.

Allowed:

card_type_id

integer

enum

required

Card brand. 1 = Mastercard, 2 = Visa, 3 = Discover, 4 = Amex.

Allowed:

card_number

string

required

^[0-9]{15,16}$

Card number. Send 15 to 16 digits, Luhn-valid, without separators.

card_exp_month

integer

required

1 to 12

Card expiration month.

card_exp_year

integer

required

2026 to 9999

Four-digit card expiration year. Must not be in the past.

card_cvv

string

required

^[0-9]{3,4}$

Card CVV or security code.

tracking1

uuid

required

Merchant user UUID in our system. Use the value shown in your account settings.

tracking2

string

required

length ≤ 255

^[A-Za-z0-9_-]+$

Merchant clickID or order reference. Used to match postbacks.

tracking3

string

required

length ≤ 64

Original upstream decline code.

tracking4

string

required

length ≤ 1000

Original upstream decline reason or message.

tracking5

string

enum

required

Product type marker for factoring decline. Always send 4.

Allowed:

ip_address

string

Customer IP at the time of order. Must be a valid IPv4 or IPv6 address.

user_agent

string

length ≤ 512

Customer browser user-agent.

browser_language

string

length ≤ 64

Customer browser language setting.

browser_timezone

string

length ≤ 64

Customer browser timezone.

browser_screen_size

string

length ≤ 32

Customer screen dimensions.

browser_screen_color_depth

string

length ≤ 16

Customer screen color depth.

browser_accept_header

string

length ≤ 1024

Customer browser Accept header.

browser_java_enabled

boolean

Whether Java is enabled in the customer browser.

browser_javascript_enabled

boolean

Whether JavaScript is enabled in the customer browser.

session_id

string

length ≤ 128

Custom session identifier to associate with the order.

Responses

200Order accepted for processing. Inspect response_code in the body to determine whether the charge succeeded, requires additional action, or was declined.

400Validation error or processing error.

401Missing or invalid X-Api-Key header.

403API key is valid but does not have permission for this operation.

500Processing-side error. Retry later or contact support if it persists.