B2B API Specification

gateway

Version 3.2.26

production
sandbox

Sale Transactions

A Sale transaction performs the operation of Authorization and Capture in one request. A Sale request must be used with encrypted values (card.number and csc) that were encrypted by PayTrace End-to-end encryption (e2ee) Library.

Keyed Sale (Card Not Present)

post /v3/card/sale/keyed

A Keyed Sale can be performed when the card is NOT present.

Parameters
X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
invoice_id
Type
string
Example
9ecaffcf-48b4-480a-91b4-a0c4d8786806

Loading...

is_invoice_pay
Type
boolean
Default
false

Loading...

silent_post
Type
string
Range
1 to 2083 characters
Example
https://example.com/payment-response

Loading...

amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Maximum Length
50

Loading...

card required
Type
object

Loading...

csc
Type
string
Range
329 to 359 characters
Example
htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

force_partial_auth_capability
Type
boolean

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

customer_id
Type
integer

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

surcharge_info
Type
object
Default
[object Object]

Loading...

Example Request
{
  "invoice_id": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "is_invoice_pay": false,
  "silent_post": "https://example.com/payment-response",
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "string",
  "card": {
    "number": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
    "expiration_month": 11,
    "expiration_year": 28
  },
  "csc": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "force_partial_auth_capability": "boolean",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "customer_id": "integer",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  },
  "surcharge_info": {}
}
Example Response
200 Successful Response
422 Validation Error

Swiped Sale (Card Present)

post /v3/card/sale/swiped

This Sale Method can be used when a Credit card is present. This method performs the operation of Authorization and Capture in one sale request.

Parameters
X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Example
Steve Smith

Loading...

csc
Type
string
Range
329 to 359 characters
Example
htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

force_partial_auth_capability
Type
boolean

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

swipe required
Type
string
Range
329 to 560 characters
Example
If this is a Magensa Reader encrypted: <br> %B403000007. 004896^YOU/A GIFT FOR ^3001000000000000000000000000000?; 4030000070004896=30010000000000000000?|0600|02A2B0CF2BE290CDF59DF1AE911E58170FE96 B48D3743EF96B55FC679DD331880471F54BCD34DB2A5C5773C5EC4DA60D4B26A2712658159F4FAEA26E7 FCAE7588E5AFE905A5E33039D3FC76C2EA15FF1|1E2ED1FBAD9FCE68031F5BCC3A3F380F1B13B234A28791 93B2DE4D75477C33036F25602B33373B26||61403000|67CF6FD161D11FC8E86DFA58E107F08C43D43593478 4A58078C01D62CD55EDF3DEC4BEB8F8036B1C7E3D449EE12A3B5551603809F0BCA03B|B03F953080911AA|F7914 A6718FB78CF|9011880B03F953000204|288A||0000 <br><br> If this is encrypted using e2ee Library: <br> htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

surcharge_info
Type
object
Default
[object Object]

Loading...

Example Request
{
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "Steve Smith",
  "csc": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "force_partial_auth_capability": "boolean",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "swipe": "If this is a Magensa Reader encrypted: <br>             %B403000007. 004896^YOU/A GIFT FOR           ^3001000000000000000000000000000?;             4030000070004896=30010000000000000000?|0600|02A2B0CF2BE290CDF59DF1AE911E58170FE96              B48D3743EF96B55FC679DD331880471F54BCD34DB2A5C5773C5EC4DA60D4B26A2712658159F4FAEA26E7             FCAE7588E5AFE905A5E33039D3FC76C2EA15FF1|1E2ED1FBAD9FCE68031F5BCC3A3F380F1B13B234A28791             93B2DE4D75477C33036F25602B33373B26||61403000|67CF6FD161D11FC8E86DFA58E107F08C43D43593478             4A58078C01D62CD55EDF3DEC4BEB8F8036B1C7E3D449EE12A3B5551603809F0BCA03B|B03F953080911AA|F7914             A6718FB78CF|9011880B03F953000204|288A||0000 <br><br>            If this is encrypted using e2ee Library: <br>            htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  },
  "surcharge_info": {}
}
Example Response
200 Successful Response
422 Validation Error

Sale By Transaction ID

post /v3/card/sale/by-transaction/{transaction_id}

This method can be used to process a sale transaction with the credit card billing information from a past transaction made within PayTrace.

Parameters
transaction_id required
Type
string

Loading...

X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Example
Steve Smith

Loading...

csc
Type
string
Range
329 to 359 characters
Example
htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

force_partial_auth_capability
Type
boolean

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

surcharge_info
Type
object
Default
[object Object]

Loading...

Example Request
{
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "Steve Smith",
  "csc": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "force_partial_auth_capability": "boolean",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  },
  "surcharge_info": {}
}
Example Response
200 Successful Response
422 Validation Error

Vault Sale By Customer ID

post /v3/card/sale/customer/{customer_id}

A Vault Sale will allow you to process a transaction with an existing Customer ID (Token) from your Customer Database (Vault) at PayTrace.

Parameters
customer_id required
Type
integer

Loading...

X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
invoice_id
Type
string
Example
9ecaffcf-48b4-480a-91b4-a0c4d8786806

Loading...

is_invoice_pay
Type
boolean
Default
false

Loading...

silent_post
Type
string
Range
1 to 2083 characters
Example
https://example.com/payment-response

Loading...

amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Example
Steve Smith

Loading...

csc
Type
string
Range
329 to 359 characters
Example
htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

force_partial_auth_capability
Type
boolean

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

customer_id
Type
integer

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

surcharge_info
Type
object
Default
[object Object]

Loading...

Example Request
{
  "invoice_id": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "is_invoice_pay": false,
  "silent_post": "https://example.com/payment-response",
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "Steve Smith",
  "csc": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "force_partial_auth_capability": "boolean",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "customer_id": "integer",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  },
  "surcharge_info": {}
}
Example Response
200 Successful Response
422 Validation Error

Protect Sale

post /v3/card/sale/pt-protect

A Protect Sale will allow you to process a transaction using the token and encryption key created when using the Protect.js UI.

Parameters
X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
hpf_token required
Type
string
Example
e369847e-3027-4174-9161-fa0d4e98d318

Loading...

enc_key required
Type
string
Example
lI785yOBMet4Rt9o4NLXEyV84WBU3tdStExcsfoaOoo=

Loading...

amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Example
Steve Smith

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

Example Request
{
  "hpf_token": "e369847e-3027-4174-9161-fa0d4e98d318",
  "enc_key": "lI785yOBMet4Rt9o4NLXEyV84WBU3tdStExcsfoaOoo=",
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "Steve Smith",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  }
}
Example Response
200 Successful Response
422 Validation Error

Protect Sale and Create Customer

post /v3/card/sale/pt-protect/customer

This method will allow you to process a transaction and create a customer profile upon the transaction approval using the token and encryption key created when using the Protect.js UI.

Parameters
X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
customer_label required
Type
string
Maximum Length
50
Example
customerLabel123

Loading...

hpf_token required
Type
string
Example
e369847e-3027-4174-9161-fa0d4e98d318

Loading...

enc_key required
Type
string
Example
lI785yOBMet4Rt9o4NLXEyV84WBU3tdStExcsfoaOoo=

Loading...

amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Example
Steve Smith

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

Example Request
{
  "customer_label": "customerLabel123",
  "hpf_token": "e369847e-3027-4174-9161-fa0d4e98d318",
  "enc_key": "lI785yOBMet4Rt9o4NLXEyV84WBU3tdStExcsfoaOoo=",
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "Steve Smith",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  }
}
Example Response
200 Successful Response
422 Validation Error

Invoice Sale and Create Customer

post /v3/card/sale/invoice-pay/customer

Processes an invoice_pay transaction and creates a customer profile upon approval.

Parameters
X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
customer_label required
Type
string
Maximum Length
50
Example
customer_label

Loading...

invoice_id required
Type
string
Example
9ecaffcf-48b4-480a-91b4-a0c4d8786806

Loading...

is_invoice_pay
Type
boolean
Default
false

Loading...

silent_post
Type
string
Range
1 to 2083 characters
Example
https://example.com/payment-response

Loading...

amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Maximum Length
50

Loading...

card required
Type
object

Loading...

csc
Type
string
Range
329 to 359 characters
Example
htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

force_partial_auth_capability
Type
boolean

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

customer_id
Type
integer

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

surcharge_info
Type
object
Default
[object Object]

Loading...

Example Request
{
  "customer_label": "customer_label",
  "invoice_id": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "is_invoice_pay": false,
  "silent_post": "https://example.com/payment-response",
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "string",
  "card": {
    "number": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
    "expiration_month": 11,
    "expiration_year": 28
  },
  "csc": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "force_partial_auth_capability": "boolean",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "customer_id": "integer",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  },
  "surcharge_info": {}
}
Example Response
200 Successful Response
422 Validation Error

Sale By Terminal ID

post /v3/card/sale/terminal/{terminal_id}

A Terminal Sale will allow you to process a transaction with an existing Terminal ID (Token) from your Semi Integrated Terminal provided by PayTrace.

The response will include the pending transaction id.

Parameters
terminal_id required
Type
string

Loading...

X-Integrator-Id
Type
string
Maximum Length
12

Loading...

X-Permalinks
Type
string
Maximum Length
4

Loading...

Request Schema
invoice_id
Type
string
Example
9ecaffcf-48b4-480a-91b4-a0c4d8786806

Loading...

is_invoice_pay
Type
boolean
Default
false

Loading...

silent_post
Type
string
Range
1 to 2083 characters
Example
https://example.com/payment-response

Loading...

amount required
Type
number
Range
0 to 100000000000000000
Example
80.55

Loading...

billing_address
Type
object

Loading...

billing_name
Type
string
Example
Steve Smith

Loading...

csc
Type
string
Range
329 to 359 characters
Example
htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

Loading...

billing_email
Type
string
Example
email@domain.com

Loading...

billing_phone
Type
string
Maximum Length
20

Loading...

customer_reference_id
Type
string
Maximum Length
50
Example
PO123456

Loading...

description
Type
string
Example
business services

Loading...

force_partial_auth_capability
Type
boolean

Loading...

invoice_number
Type
string
Example
17

Loading...

merchant_id required
Type
integer
Example
246810

Loading...

custom_dba
Type
string
Example
Doing Business As Test Company

Loading...

return_clr
Type
boolean
Example
false

Loading...

customer_id
Type
integer

Loading...

shipping_address
Type
object

Loading...

shipping_name
Type
string
Example
Steve Smith

Loading...

tax_amount
Type
string
Example
2.16

Loading...

discretionary_data
Type
array

Loading...

surcharge_info
Type
object
Default
[object Object]

Loading...

Example Request
{
  "invoice_id": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "is_invoice_pay": false,
  "silent_post": "https://example.com/payment-response",
  "amount": 80.55,
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_name": "Steve Smith",
  "csc": "htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY             u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3             jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb             oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr            9WKv92V3M+H6Gsx7z0iCbn+8Ug==",
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "customer_reference_id": "PO123456",
  "description": "business services",
  "force_partial_auth_capability": "boolean",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "customer_id": "integer",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  },
  "surcharge_info": {}
}
Example Response
200 Successful Response
422 Validation Error

Contact Us

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.