B2B API Specification | North Developer

B2B Payment API

ACH Check Processing Apis

Check or ACH (Automated Clearing House) transactions can be processed through the PayTrace API. If you would like to enable check processing within your account, you will need to contact your Merchant Service Provider. They will be able to enable check processing for you within PayTrace. Currently, this API supports only the Trace ACH check processor.

ACH Payment Request

post /v3/checks/payment

Check or ACH (Automated Clearing House) Payment transactions can be performed with this method by providing the customer's key entered checking account details. This method also allows to process a check transaction with an existing Customer ID from Customer Database within PayTrace.


        Encrypted values by the PayTrace End-to-end encryption (e2ee) Library
        must be used with this request.

Parameters

X-Integrator-Id

string

Maximum:

Request Schema

merchant_id required

integer

idempotency_key

string

Maximum:

Example:

9ecaffcf-48b4-480a-91b4-a0c4d8786806

is_aof

boolean

Default:

false

customer_id

integer

Example:

12345671

std_entry_class required

string

Example:

CCD

bank_account

object

invoice_number

string

Maximum:

Example:

INV453AB43FF

description

string0 to 255 characters

Example:

ACH Check Payment

billing_address

object

billing_name

string

Example:

Steve Smith

billing_email

string

Example:

email@domain.com

shipping_address

object

shipping_name

string

Example:

Steve Smith

amount required

number

Example:

12.34

Example Request

{
  "merchant_id": "integer",
  "idempotency_key": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "is_aof": false,
  "customer_id": 12345671,
  "std_entry_class": "CCD",
  "bank_account": {
    "account_number": "56745746632235353",
    "routing_number": "190000004",
    "account_type": "Checking"
  },
  "invoice_number": "INV453AB43FF",
  "description": "ACH Check Payment",
  "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",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "amount": 12.34
}

Example Response

201 Successful Response

422 Validation Error

ACH Void Transaction Request

post /v3/checks/void/payment

Check or ACH (Automated Clearing House) Void transaction cancels a pending ACH transaction, stopping funds from being transferred by providing the transaction UUID to identify the transaction to be voided. This method is used for Void a unsettled Prenote, Payment, Refund, Payout/Unreferenced Refund Request by providing the customer's key entered checking account details

Parameters

X-Integrator-Id

string

Maximum:

Request Schema

merchant_id required

integer

ach_transaction_id required

string

Example:

9ecaffcf-48b4-480a-91b4-a0c4d8786806

Example Request

{
  "merchant_id": "integer",
  "ach_transaction_id": "9ecaffcf-48b4-480a-91b4-a0c4d8786806"
}

Example Response

201 Successful Response

422 Validation Error

ACH Unreferenced Refund Request

post /v3/checks/refund/unref

Check or ACH (Automated Clearing House) Unreferenced Refund, facilitates the automated refunding of funds to customers without the necessity of a specific payment reference. This method is used for placing a Payout/Unreferenced Refund Request by providing the customer's key entered checking account details.


        Encrypted values by the PayTrace End-to-end encryption (e2ee) Library
        must be used with this request.

Parameters

X-Integrator-Id

string

Maximum:

Request Schema

merchant_id required

integer

idempotency_key

string

Maximum:

Example:

9ecaffcf-48b4-480a-91b4-a0c4d8786806

is_aof

boolean

Default:

false

customer_id

integer

Example:

12345671

std_entry_class required

string

Enum:

CCD

PPD

WEB

TEL

Example:

CCD

bank_account

object

invoice_number

string

Maximum:

Example:

INV453AB43FF

description

string0 to 255 characters

Example:

ACH Check Payment

billing_address

object

billing_name

string

Example:

Steve Smith

billing_email

string

Example:

email@domain.com

shipping_address

object

shipping_name

string

Example:

Steve Smith

amount required

number

Example:

12.34

Example Request

{
  "merchant_id": "integer",
  "idempotency_key": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "is_aof": false,
  "customer_id": 12345671,
  "std_entry_class": "CCD",
  "bank_account": {
    "account_number": "56745746632235353",
    "routing_number": "190000004",
    "account_type": "Checking"
  },
  "invoice_number": "INV453AB43FF",
  "description": "ACH Check Payment",
  "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",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "amount": 12.34
}

Example Response

201 Successful Response

422 Validation Error

ACH Refund Request

post /v3/checks/refund/ref

Check or ACH (Automated Clearing House) Refund transactions can be performed with this method by providing the original payment transaction UUID and the refund amount.

Parameters

X-Integrator-Id

string

Maximum:

Request Schema

merchant_id required

integer

idempotency_key

string

Maximum:

Example:

9ecaffcf-48b4-480a-91b4-a0c4d8786806

ach_transaction_id required

string

Example:

9ecaffcf-48b4-480a-91b4-a0c4d8786806

amount required

number

Example:

12.34

Example Request

{
  "merchant_id": "integer",
  "idempotency_key": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "ach_transaction_id": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "amount": 12.34
}

Example Response

201 Successful Response

422 Validation Error

ACH Prenote Request

post /v3/checks/prenote

Check or ACH (Automated Clearing House) Prenote transactions allow for the validation of bank account details before initiating payments. This method facilitates a zero-dollar transaction to verify the accuracy of account and routing information, ensuring the account is valid and capable of receiving future transactions. Prenote transactions serve as a preliminary step to validate bank account information prior to processing payments.


        Encrypted values by the PayTrace End-to-end encryption (e2ee) Library
        must be used with this request.

Parameters

X-Integrator-Id

string

Maximum:

Request Schema

merchant_id required

integer

idempotency_key

string

Maximum:

Example:

9ecaffcf-48b4-480a-91b4-a0c4d8786806

is_aof

boolean

Default:

false

customer_id

integer

Example:

12345671

std_entry_class required

string

Example:

CCD

bank_account

object

invoice_number

string

Maximum:

Example:

INV453AB43FF

description

string0 to 255 characters

Example:

ACH Check Payment

billing_address

object

billing_name

string

Example:

Steve Smith

billing_email

string

Example:

email@domain.com

shipping_address

object

shipping_name

string

Example:

Steve Smith

Example Request

{
  "merchant_id": "integer",
  "idempotency_key": "9ecaffcf-48b4-480a-91b4-a0c4d8786806",
  "is_aof": false,
  "customer_id": 12345671,
  "std_entry_class": "CCD",
  "bank_account": {
    "account_number": "56745746632235353",
    "routing_number": "190000004",
    "account_type": "Checking"
  },
  "invoice_number": "INV453AB43FF",
  "description": "ACH Check Payment",
  "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",
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith"
}

Example Response

201 Successful Response

422 Validation Error