DEVELOPER
DEVELOPER

Embedded Checkout API Specification

ecommercehosted-paymentscheckout

Version 1.0.0

Payments

Card and token payments including sale, authorization, capture, refund, void, reversal, and related operations.

Mocks authorize and capture credit card payment

post /api/payments/sale/mock
Request Schema
payment_method required
Type
string
Enum
creditachdebt
Example
credit

Loading...

amount
Type
number
Range
0.01 to 99999999999.99
Example
12.55

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

account_nbr
Type
string
Pattern
^[0-9]+$
Range
4 to 20 characters
Example
4111111111111111

Loading...

exp_date
Type
string
Pattern
^[0-9]+$
Maximum Length
4
Example
2904

Loading...

cvv2
Type
string
Pattern
^[0-9]+$
Range
3 to 4 characters
Example
123

Loading...

orig_auth_guid
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

routing_nbr
Type
string
Pattern
^[0-9]+$
Range
9 to 9 characters
Example
31100092

Loading...

account_type
Type
string
Enum
checkingsavings
Example
savings

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

tran_fee
Type
number
Range
0.01 to 99999999999.99
Example
2.51

Loading...

convenience_fee
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tip_amt
Type
number
Range
0 to 99999999999.99
Example
1.35

Loading...

tax_amt
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tax_exempt
Type
string
Maximum Length
1
Enum
YN
Example
Y

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

tlv_sets
Type
string
Maximum Length
9999

Loading...

enhanced_tlv
Type
string
Maximum Length
2000
Example
0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

currency_code
Type
string
Pattern
^[0-9]+$
Maximum Length
3
Example
840

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

addenda_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "first_name": "John",
  "last_name": "Doe",
  "account_nbr": "4111111111111111",
  "exp_date": "2904",
  "cvv2": "123",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "routing_nbr": 31100092,
  "account_type": "savings",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "tran_fee": 2.51,
  "convenience_fee": 3.99,
  "tip_amt": 1.35,
  "tax_amt": 3.99,
  "tax_exempt": "Y",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "tlv_sets": "string",
  "enhanced_tlv": "0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "currency_code": "840",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "addenda_1": "Abc123",
  "addenda_2": "Abc123",
  "addenda_3": "Abc123",
  "addenda_4": "Abc123",
  "addenda_5": "Abc123",
  "addenda_6": "Abc123",
  "addenda_7": "Abc123",
  "addenda_8": "Abc123",
  "addenda_9": "Abc123",
  "addenda_10": "Abc123"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

Sale (Authorize And Capture)

post /api/payments/sale
Request Schema
payment_method required
Type
string
Enum
creditachdebt
Example
credit

Loading...

amount
Type
number
Range
0.01 to 99999999999.99
Example
12.55

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

account_nbr
Type
string
Pattern
^[0-9]+$
Range
4 to 20 characters
Example
4111111111111111

Loading...

exp_date
Type
string
Pattern
^[0-9]+$
Maximum Length
4
Example
2904

Loading...

cvv2
Type
string
Pattern
^[0-9]+$
Range
3 to 4 characters
Example
123

Loading...

orig_auth_guid
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

routing_nbr
Type
string
Pattern
^[0-9]+$
Range
9 to 9 characters
Example
31100092

Loading...

account_type
Type
string
Enum
checkingsavings
Example
savings

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

tran_fee
Type
number
Range
0.01 to 99999999999.99
Example
2.51

Loading...

convenience_fee
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tip_amt
Type
number
Range
0 to 99999999999.99
Example
1.35

Loading...

tax_amt
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tax_exempt
Type
string
Maximum Length
1
Enum
YN
Example
Y

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

tlv_sets
Type
string
Maximum Length
9999

Loading...

enhanced_tlv
Type
string
Maximum Length
2000
Example
0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

currency_code
Type
string
Pattern
^[0-9]+$
Maximum Length
3
Example
840

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

addenda_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "first_name": "John",
  "last_name": "Doe",
  "account_nbr": "4111111111111111",
  "exp_date": "2904",
  "cvv2": "123",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "routing_nbr": 31100092,
  "account_type": "savings",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "tran_fee": 2.51,
  "convenience_fee": 3.99,
  "tip_amt": 1.35,
  "tax_amt": 3.99,
  "tax_exempt": "Y",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "tlv_sets": "string",
  "enhanced_tlv": "0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "currency_code": "840",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "addenda_1": "Abc123",
  "addenda_2": "Abc123",
  "addenda_3": "Abc123",
  "addenda_4": "Abc123",
  "addenda_5": "Abc123",
  "addenda_6": "Abc123",
  "addenda_7": "Abc123",
  "addenda_8": "Abc123",
  "addenda_9": "Abc123",
  "addenda_10": "Abc123"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

Authorization only

post /api/payments/auth
Request Schema
payment_method required
Type
string
Enum
creditachdebt
Example
credit

Loading...

amount
Type
number
Range
0.01 to 99999999999.99
Example
12.55

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

account_nbr
Type
string
Pattern
^[0-9]+$
Range
4 to 20 characters
Example
4111111111111111

Loading...

exp_date
Type
string
Pattern
^[0-9]+$
Maximum Length
4
Example
2904

Loading...

cvv2
Type
string
Pattern
^[0-9]+$
Range
3 to 4 characters
Example
123

Loading...

orig_auth_guid
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

routing_nbr
Type
string
Pattern
^[0-9]+$
Range
9 to 9 characters
Example
31100092

Loading...

account_type
Type
string
Enum
checkingsavings
Example
savings

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

tran_fee
Type
number
Range
0.01 to 99999999999.99
Example
2.51

Loading...

convenience_fee
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tip_amt
Type
number
Range
0 to 99999999999.99
Example
1.35

Loading...

tax_amt
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tax_exempt
Type
string
Maximum Length
1
Enum
YN
Example
Y

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

tlv_sets
Type
string
Maximum Length
9999

Loading...

enhanced_tlv
Type
string
Maximum Length
2000
Example
0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

currency_code
Type
string
Pattern
^[0-9]+$
Maximum Length
3
Example
840

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

addenda_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "first_name": "John",
  "last_name": "Doe",
  "account_nbr": "4111111111111111",
  "exp_date": "2904",
  "cvv2": "123",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "routing_nbr": 31100092,
  "account_type": "savings",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "tran_fee": 2.51,
  "convenience_fee": 3.99,
  "tip_amt": 1.35,
  "tax_amt": 3.99,
  "tax_exempt": "Y",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "tlv_sets": "string",
  "enhanced_tlv": "0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "currency_code": "840",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "addenda_1": "Abc123",
  "addenda_2": "Abc123",
  "addenda_3": "Abc123",
  "addenda_4": "Abc123",
  "addenda_5": "Abc123",
  "addenda_6": "Abc123",
  "addenda_7": "Abc123",
  "addenda_8": "Abc123",
  "addenda_9": "Abc123",
  "addenda_10": "Abc123"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

BRIC Storage

post /api/payments/storage
Request Schema
payment_method required
Type
string
Enum
creditach
Example
credit

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

account_nbr
Type
string
Pattern
^[0-9]+$
Range
4 to 20 characters
Example
4111111111111111

Loading...

exp_date
Type
string
Pattern
^[0-9]+$
Maximum Length
4
Example
2904

Loading...

cvv2
Type
string
Pattern
^[0-9]+$
Range
3 to 4 characters
Example
123

Loading...

orig_auth_guid
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

routing_nbr
Type
string
Pattern
^[0-9]+$
Range
9 to 9 characters
Example
31100092

Loading...

account_type
Type
string
Enum
checkingsavings
Example
savings

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

addenda_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

Example Request
{
  "payment_method": "credit",
  "first_name": "John",
  "last_name": "Doe",
  "account_nbr": "4111111111111111",
  "exp_date": "2904",
  "cvv2": "123",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "routing_nbr": 31100092,
  "account_type": "savings",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "addenda_1": "Abc123",
  "addenda_2": "Abc123",
  "addenda_3": "Abc123",
  "addenda_4": "Abc123",
  "addenda_5": "Abc123",
  "addenda_6": "Abc123",
  "addenda_7": "Abc123",
  "addenda_8": "Abc123",
  "addenda_9": "Abc123",
  "addenda_10": "Abc123"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

Account Verification System request using credit card data

post /api/payments/avs
Request Schema
payment_method required
Type
string
Enum
creditach
Example
credit

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

account_nbr
Type
string
Pattern
^[0-9]+$
Range
4 to 20 characters
Example
4111111111111111

Loading...

exp_date
Type
string
Pattern
^[0-9]+$
Maximum Length
4
Example
2904

Loading...

cvv2
Type
string
Pattern
^[0-9]+$
Range
3 to 4 characters
Example
123

Loading...

orig_auth_guid
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

routing_nbr
Type
string
Pattern
^[0-9]+$
Range
9 to 9 characters
Example
31100092

Loading...

account_type
Type
string
Enum
checkingsavings
Example
savings

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

addenda_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

addenda_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

Example Request
{
  "payment_method": "credit",
  "first_name": "John",
  "last_name": "Doe",
  "account_nbr": "4111111111111111",
  "exp_date": "2904",
  "cvv2": "123",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "routing_nbr": 31100092,
  "account_type": "savings",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "addenda_1": "Abc123",
  "addenda_2": "Abc123",
  "addenda_3": "Abc123",
  "addenda_4": "Abc123",
  "addenda_5": "Abc123",
  "addenda_6": "Abc123",
  "addenda_7": "Abc123",
  "addenda_8": "Abc123",
  "addenda_9": "Abc123",
  "addenda_10": "Abc123"
}
Example Response
200 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

BRIC/Token Sale (Authorize And Capture)

post /api/payments/token/sale
Request Schema
payment_method required
Type
string
Enum
creditachdebt
Example
credit

Loading...

amount required
Type
number
Range
0.01 to 99999999999.99
Example
12.55

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

orig_auth_guid required
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

tran_fee
Type
number
Range
0.01 to 99999999999.99
Example
2.51

Loading...

convenience_fee
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tip_amt
Type
number
Range
0 to 99999999999.99
Example
1.35

Loading...

tax_amt
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tax_exempt
Type
string
Maximum Length
1
Enum
YN
Example
Y

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

tlv_sets
Type
string
Maximum Length
9999

Loading...

enhanced_tlv
Type
string
Maximum Length
2000
Example
0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

currency_code
Type
string
Pattern
^[0-9]+$
Maximum Length
3
Example
840

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

card_type
Type
string
Enum
VisaMasterCardAMEXDiscoverOther
Example
Visa

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "first_name": "John",
  "last_name": "Doe",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "tran_fee": 2.51,
  "convenience_fee": 3.99,
  "tip_amt": 1.35,
  "tax_amt": 3.99,
  "tax_exempt": "Y",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "tlv_sets": "string",
  "enhanced_tlv": "0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "currency_code": "840",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "card_type": "Visa"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
500 Server error

Refund

put /api/payments/refund
Request Schema
payment_method required
Type
string
Enum
creditachdebt
Example
credit

Loading...

amount required
Type
number
Range
0.01 to 99999999999.99
Example
12.55

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

orig_auth_guid required
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

tran_fee
Type
number
Range
0.01 to 99999999999.99
Example
2.51

Loading...

convenience_fee
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tip_amt
Type
number
Range
0 to 99999999999.99
Example
1.35

Loading...

tax_amt
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tax_exempt
Type
string
Maximum Length
1
Enum
YN
Example
Y

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

tlv_sets
Type
string
Maximum Length
9999

Loading...

enhanced_tlv
Type
string
Maximum Length
2000
Example
0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

currency_code
Type
string
Pattern
^[0-9]+$
Maximum Length
3
Example
840

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

card_type
Type
string
Enum
VisaMasterCardAMEXDiscoverOther
Example
Visa

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "first_name": "John",
  "last_name": "Doe",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "tran_fee": 2.51,
  "convenience_fee": 3.99,
  "tip_amt": 1.35,
  "tax_amt": 3.99,
  "tax_exempt": "Y",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "tlv_sets": "string",
  "enhanced_tlv": "0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "currency_code": "840",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "card_type": "Visa"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

Capture

put /api/payments/capture
Request Schema
payment_method required
Type
string
Enum
creditachdebt
Example
credit

Loading...

amount required
Type
number
Range
0.01 to 99999999999.99
Example
12.55

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

orig_auth_guid required
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Range
5 to 10 characters
Example
12345

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

tran_fee
Type
number
Range
0.01 to 99999999999.99
Example
2.51

Loading...

convenience_fee
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tip_amt
Type
number
Range
0 to 99999999999.99
Example
1.35

Loading...

tax_amt
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tax_exempt
Type
string
Maximum Length
1
Enum
YN
Example
Y

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

tlv_sets
Type
string
Maximum Length
9999

Loading...

enhanced_tlv
Type
string
Maximum Length
2000
Example
0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

currency_code
Type
string
Pattern
^[0-9]+$
Maximum Length
3
Example
840

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

ident_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
15

Loading...

card_type
Type
string
Enum
VisaMasterCardAMEXDiscoverOther
Example
Visa

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "first_name": "John",
  "last_name": "Doe",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "industry_type": "E",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "tran_fee": 2.51,
  "convenience_fee": 3.99,
  "tip_amt": 1.35,
  "tax_amt": 3.99,
  "tax_exempt": "Y",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "tlv_sets": "string",
  "enhanced_tlv": "0010006VISA_G00200510010009CUSTCODE7005000523.000090003840011000603142200300900010007COMCODE0020009ITEM,DESC0030008PRODCODE004000130050004EACH0060006300.000100006600.00",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "currency_code": "840",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe",
  "ident_nbr": "string",
  "card_type": "Visa"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

Void

put /api/payments/void
Request Schema
payment_method required
Type
string
Enum
creditach
Example
credit

Loading...

amount
Type
number
Range
0 to 99999999999.99
Example
12.55

Loading...

orig_auth_guid required
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "industry_type": "E",
  "tran_nbr": "123",
  "batch_id": "20250407"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

Reversal

put /api/payments/reversal
Request Schema
payment_method required
Type
string
Enum
creditach
Example
credit

Loading...

amount
Type
number
Range
0 to 99999999999.99
Example
12.55

Loading...

orig_auth_guid required
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

industry_type
Type
string
Maximum Length
1
Enum
EMP
Example
E

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

Example Request
{
  "payment_method": "credit",
  "amount": 12.55,
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "industry_type": "E",
  "tran_nbr": "123",
  "batch_id": "20250407"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error

Cloud Ingenico

post /api/payments/ingenico
Request Schema
device_id
Type
string
Range
1 to 80 characters

Loading...

tran_type required
Type
string
Enum
SALEAUTHCCR1CCR2CCR4CCR8CCR7CCR9CCRXCCRZDB00DB01DB0VEB00EB01EB02EB05EB07EB0VPROMPTABORT
Example
CCR1

Loading...

amount
Type
number
Range
0 to 99999999999.99
Example
12.55

Loading...

first_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
John

Loading...

last_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Doe

Loading...

orig_auth_guid
Type
string
Pattern
^[a-zA-Z0-9]+$
Maximum Length
20
Example
0V7017HDJXK00PNZKBE

Loading...

address
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
30
Example
1234 My Street

Loading...

city
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
Phoenix

Loading...

state
Type
string
Maximum Length
3
Example
AZ

Loading...

zip_code
Type
string
Maximum Length
10
Example
12345

Loading...

invoice_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
invoiceABC123

Loading...

order_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
orderABC123

Loading...

tran_nbr
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
123

Loading...

batch_id
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
20250407

Loading...

user_data_1
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_3
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_4
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_5
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_6
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_7
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_8
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_9
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

user_data_10
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
80
Example
Abc123

Loading...

aci
Type
string
Maximum Length
2
Enum
ACAHDQ
Example
D

Loading...

aci_ext
Type
string
Maximum Length
2
Enum
AEAFAOCACCDSHRIAIPNSRARBRSSAUP
Example
RB

Loading...

tran_fee
Type
number
Range
0.01 to 99999999999.99
Example
2.51

Loading...

convenience_fee
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tip_amt
Type
number
Range
0 to 99999999999.99
Example
1.35

Loading...

tax_amt
Type
number
Range
0 to 99999999999.99
Example
3.99

Loading...

tax_exempt
Type
string
Maximum Length
1
Enum
YN
Example
Y

Loading...

cof_period
Type
number
Range
0 to 24

Loading...

soft_descriptor
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

soft_descriptor_2
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
40
Example
Jac D’s Construction

Loading...

reference_nbr
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
25
Example
referenceABC123

Loading...

phone_cell
Type
string
Pattern
^[0-9]+$
Maximum Length
10
Example
3025551234

Loading...

currency_code
Type
string
Pattern
^[0-9]+$
Maximum Length
3
Example
840

Loading...

verbose_response
Type
string
Maximum Length
1
Enum
Y
Example
Y

Loading...

std_entry_class
Type
string
Maximum Length
3
Enum
ARCCCDCIECTXDNEPPDRCKTELWEB
Example
WEB

Loading...

recv_name
Type
string
Pattern
^[a-zA-Z0-9 \/.\-@_*,#&+']+$
Maximum Length
22
Example
John Doe

Loading...

Example Request
{
  "device_id": "string",
  "tran_type": "CCR1",
  "amount": 12.55,
  "first_name": "John",
  "last_name": "Doe",
  "orig_auth_guid": "0V7017HDJXK00PNZKBE",
  "address": "1234 My Street",
  "city": "Phoenix",
  "state": "AZ",
  "zip_code": "12345",
  "invoice_nbr": "invoiceABC123",
  "order_nbr": "orderABC123",
  "tran_nbr": "123",
  "batch_id": "20250407",
  "user_data_1": "Abc123",
  "user_data_2": "Abc123",
  "user_data_3": "Abc123",
  "user_data_4": "Abc123",
  "user_data_5": "Abc123",
  "user_data_6": "Abc123",
  "user_data_7": "Abc123",
  "user_data_8": "Abc123",
  "user_data_9": "Abc123",
  "user_data_10": "Abc123",
  "aci": "D",
  "aci_ext": "RB",
  "tran_fee": 2.51,
  "convenience_fee": 3.99,
  "tip_amt": 1.35,
  "tax_amt": 3.99,
  "tax_exempt": "Y",
  "cof_period": "number",
  "soft_descriptor": "Jac D’s Construction",
  "soft_descriptor_2": "Jac D’s Construction",
  "reference_nbr": "referenceABC123",
  "phone_cell": "3025551234",
  "currency_code": "840",
  "verbose_response": "Y",
  "std_entry_class": "WEB",
  "recv_name": "John Doe"
}
Example Response
200 Payment processed successfully
201 Payment processed successfully
400 Invalid input
401 Unauthorized - Invalid or missing authentication token
404 Resource not found
500 Server error
Get Started
Working With UsHardwareSecurityFAQsGlossaryTags by Topic
Products
In-Person PaymentsOnline PaymentsFull-FeaturedMerchant Management
Explore
About UsBlogNorth.comNorth HubNorth Exchange
More
Log InCreate AccountContact UsTerms of UsePrivacy PolicyCookies
©2026 North is a registered DBA of NorthAB, LLC. All rights reserved. North is a registered ISO of BMO Harris Bank N.A., Chicago, IL, Citizens Bank N.A., Providence, RI, The Bancorp Bank, Philadelphia, PA, FFB Bank, Fresno, CA, Wells Fargo Bank, N.A., Concord, CA, and PNC Bank, N.A.