B2B API Specification | North Developer

B2B Payment API

EMV

Add secure EMV functionality to your applications with PayTrace’s semi-integrated EMV solution. By simply plugging in a few extra lines of code, you will gain access our secure-encrypted keyboard emulated EMV device.

PayTrace’s EMV 2.0 allows the host application to acquire secure-encrypted card information from the ID TECH Augusta EMV reader. The card data is encrypted at the point of interaction, ensuring that sensitive cardholder data is never exposed to your environment. This will add a layer of security to your card-present chip transactions and enable merchants to qualify for Level III interchange rates using PayTrace EMV 2.0.

PayTrace EMV 2.0 uses a customized encryption and configuration file. Only PayTrace authorized distributors can securely configure the ID Tech Augusta device to work with our service. For more information regarding these authorized distributors, please see the PayTrace Recommended Hardware page.

EMV Sale (Card Present)

post /v3/card/sale/emv

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

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

amount required

number

Example:

80.55

billing_address

object

billing_name

string

Example:

Steve Smith

csc

string329 to 359 characters

Example:

htpAmr1TJ2hujwO/ObS8oFG3/AhF3AU0zh4QzgynFJejRxUOoyJ1MTXW54UD6F2cvuDCgLLMjY u1K8ybAX/Ap4HvsthqdMz5lYhDj1GwcDBUnZQx+upD/8gZNUHnm5S4EZkAXMNT79iwLCd++X97yOatd3 jhjxaC0zdRUABYr6PuVEYa7gXTEO3LIiOuA/noLVhrD7ZPni8dnCluyIk2z2k6OwDdCYFwvgpuuZ/luRb oG07uYBm1TfHnrLkuCGOxeP7B8Aa0rY1du7GFwXxYadI21AqrgM+DCJLfX156lil0gL4D/ZMQoTIr1hqDr 9WKv92V3M+H6Gsx7z0iCbn+8Ug==

billing_email

string

Example:

email@domain.com

billing_phone

string

Maximum:

customer_reference_id

string

Maximum:

Example:

PO123456

description

string

Example:

business services

emv_data required

string

Example:

DFEE25020203DFEE26022201DFEE120A62994997060000A00021DFEF5D134761CCCCCCCC0010D2 212201CCCCCCCCCCCCCC572011075635C199B5AE46FB3238EACFAFC67FEE20DF89906C2D14C694107E4 E30DCDFEF5B084761CCCCCCCC00105A1021710493D36CD03AE81FD809E226C3155F201A554154 205553412F5465737420436172642030342020202020205F24032212315F25031903015F28 0208405F2A0208405F2D02656E5F3401015F570100500B56495341204352454449 544F07A000000003101082021C008407A00000000310108C159F02069F03069F 1A0295055F2A029A039C019F37048E0A00000000000000001F008D178A029F02069 F03069F1A0295055F2A029A039C019F37049C01009F02060000000000009F03060000 000000009F13009F1E0834543330313733329F20009F34031F00029F360200839F370 49D53D32A9F38009F3901059F4D009F4F009F530152950580000000009B0268008A0 25A3399009F5B009F4005F000F0A0019F0607A00000000310109F33036028C89F3501 219F1A0208409F26081458EFBEADAEAED49F2701809F100706010A03A0B000DFEF5720 494420544543482041756775737461205553422D4B422056312E30332E303135

force_partial_auth_capability

boolean

invoice_number

string

Example:

merchant_id required

integer

Example:

246810

custom_dba

string

Example:

Doing Business As Test Company

return_clr

boolean

Example:

false

shipping_address

object

shipping_name

string

Example:

Steve Smith

tax_amount

string

Example:

2.16

discretionary_data

array

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",
  "emv_data": "DFEE25020203DFEE26022201DFEE120A62994997060000A00021DFEF5D134761CCCCCCCC0010D2             212201CCCCCCCCCCCCCC572011075635C199B5AE46FB3238EACFAFC67FEE20DF89906C2D14C694107E4             E30DCDFEF5B084761CCCCCCCC00105A1021710493D36CD03AE81FD809E226C3155F201A554154             205553412F5465737420436172642030342020202020205F24032212315F25031903015F28             0208405F2A0208405F2D02656E5F3401015F570100500B56495341204352454449             544F07A000000003101082021C008407A00000000310108C159F02069F03069F             1A0295055F2A029A039C019F37048E0A00000000000000001F008D178A029F02069             F03069F1A0295055F2A029A039C019F37049C01009F02060000000000009F03060000             000000009F13009F1E0834543330313733329F20009F34031F00029F360200839F370             49D53D32A9F38009F3901059F4D009F4F009F530152950580000000009B0268008A0             25A3399009F5B009F4005F000F0A0019F0607A00000000310109F33036028C89F3501             219F1A0208409F26081458EFBEADAEAED49F2701809F100706010A03A0B000DFEF5720             494420544543482041756775737461205553422D4B422056312E30332E303135",
  "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"
  }
}

Example Response

200 Successful Response

422 Validation Error

EMV Authorization (Card Present)

post /v3/card/authorize/emv

An EMV Authorization can be performed when a Credit card is present.

This method verifies a customer's credit card information and places a hold on the amount requested. A Capture request can be submitted later to convert this authorization into a Sale, that can be settled for payment.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

amount required

number

Example:

80.55

billing_address

object

billing_name

string

Example:

Steve Smith

csc

string329 to 359 characters

Example:

billing_email

string

Example:

email@domain.com

billing_phone

string

Maximum:

customer_reference_id

string

Maximum:

Example:

PO123456

description

string

Example:

business services

emv_data required

string

Example:

force_partial_auth_capability

boolean

invoice_number

string

Example:

merchant_id required

integer

Example:

246810

custom_dba

string

Example:

Doing Business As Test Company

return_clr

boolean

Example:

false

shipping_address

object

shipping_name

string

Example:

Steve Smith

tax_amount

string

Example:

2.16

discretionary_data

array

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",
  "emv_data": "DFEE25020203DFEE26022201DFEE120A62994997060000A00021DFEF5D134761CCCCCCCC0010D2             212201CCCCCCCCCCCCCC572011075635C199B5AE46FB3238EACFAFC67FEE20DF89906C2D14C694107E4             E30DCDFEF5B084761CCCCCCCC00105A1021710493D36CD03AE81FD809E226C3155F201A554154             205553412F5465737420436172642030342020202020205F24032212315F25031903015F28             0208405F2A0208405F2D02656E5F3401015F570100500B56495341204352454449             544F07A000000003101082021C008407A00000000310108C159F02069F03069F             1A0295055F2A029A039C019F37048E0A00000000000000001F008D178A029F02069             F03069F1A0295055F2A029A039C019F37049C01009F02060000000000009F03060000             000000009F13009F1E0834543330313733329F20009F34031F00029F360200839F370             49D53D32A9F38009F3901059F4D009F4F009F530152950580000000009B0268008A0             25A3399009F5B009F4005F000F0A0019F0607A00000000310109F33036028C89F3501             219F1A0208409F26081458EFBEADAEAED49F2701809F100706010A03A0B000DFEF5720             494420544543482041756775737461205553422D4B422056312E30332E303135",
  "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"
  }
}

Example Response

200 Successful Response

422 Validation Error

EMV Refund Authorization (Card Present)

post /v3/card/refund/emv

This method can be used when a credit card is present. It issues credit back to the credit card holder's account.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

amount required

number

Example:

80.55

billing_address

object

billing_name

string

Example:

Steve Smith

csc

string329 to 359 characters

Example:

billing_email

string

Example:

email@domain.com

billing_phone

string

Maximum:

customer_reference_id

string

Maximum:

Example:

PO123456

description

string

Example:

business services

emv_data required

string

Example:

force_partial_auth_capability

boolean

invoice_number

string

Example:

merchant_id required

integer

Example:

246810

custom_dba

string

Example:

Doing Business As Test Company

return_clr

boolean

Example:

false

shipping_address

object

shipping_name

string

Example:

Steve Smith

tax_amount

string

Example:

2.16

discretionary_data

array

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",
  "emv_data": "DFEE25020203DFEE26022201DFEE120A62994997060000A00021DFEF5D134761CCCCCCCC0010D2             212201CCCCCCCCCCCCCC572011075635C199B5AE46FB3238EACFAFC67FEE20DF89906C2D14C694107E4             E30DCDFEF5B084761CCCCCCCC00105A1021710493D36CD03AE81FD809E226C3155F201A554154             205553412F5465737420436172642030342020202020205F24032212315F25031903015F28             0208405F2A0208405F2D02656E5F3401015F570100500B56495341204352454449             544F07A000000003101082021C008407A00000000310108C159F02069F03069F             1A0295055F2A029A039C019F37048E0A00000000000000001F008D178A029F02069             F03069F1A0295055F2A029A039C019F37049C01009F02060000000000009F03060000             000000009F13009F1E0834543330313733329F20009F34031F00029F360200839F370             49D53D32A9F38009F3901059F4D009F4F009F530152950580000000009B0268008A0             25A3399009F5B009F4005F000F0A0019F0607A00000000310109F33036028C89F3501             219F1A0208409F26081458EFBEADAEAED49F2701809F100706010A03A0B000DFEF5720             494420544543482041756775737461205553422D4B422056312E30332E303135",
  "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"
  }
}

Example Response

200 Successful Response

422 Validation Error