ACH

Create an ACH Sale

post

For member variable "AccountType" use the following values:

1. Personal Checking = 1
2. Personal Saving = 2
3. Business Checking = 3
4. Business Saving = 4

Header parameters

SessKeystringrequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

ChargeDetailsobjectoptional

AcctHolderobjectoptional

EndCustomerobjectoptional

PurchItemsobjectoptional

MerchIDintegeroptional

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ACH/Sale' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "ChargeDetails": {
      "AccountNumber": "878460000256",
      "RoutingNumber": "211274515",
      "Amount": 10.25,
      "AccountType": 1
    },
    "AcctHolder": {
      "Firstname": "Sally",
      "Lastname": "Smith",
      "Company": "",
      "Title": "",
      "Url": "",
      "BillIngAdress": {
        "Address1": "123 Test Road",
        "Address2": "",
        "City": "Portland",
        "State": "ME",
        "ZIP": "04005",
        "Country": "USA"
      },
      "Email": "[e-mail]",
      "Phone": "8775558472"
    },
    "EndCustomer": {
      "Firstname": "Sally",
      "Lastname": "Smith",
      "Company": "",
      "Title": "",
      "Url": "",
      "BillIngAdress": {
        "Address1": "123 Test Road",
        "Address2": "",
        "City": "Portland",
        "State": "ME",
        "ZIP": "04005",
        "Country": "USA"
      },
      "Email": "[e-mail]",
      "Phone": "8775558472"
    },
    "PurchItems": {
      "ServiceDescrip": "FROM API TESTER",
      "ClientRefID": "12456AA",
      "RPGUID": "3d3424a6-c5f3-4c28"
    },
    "MerchID": 1
  }'

200

200

{
  "ACHTransactionResult": {
    "AuthID": "69017501",
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "TxID 1381 Approved",
    "TxApproved": true,
    "TxID": 1381,
    "uniqueTranID": "16790131F349BCBA"
  }
}

Successful ACH Sale transaction

Create an ACH Combo Sale and Consent

post

This method creates both an ACH sale and consent. To create a consent only without processing the sale, set the Amount to zero.

For member variable "AccountType" use the following values:

1. Personal Checking = 1
2. Personal Saving = 2
3. Business Checking = 3
4. Business Saving = 4

Header parameters

SessKeystringrequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

ChargeDetailsobjectoptional

AcctHolderobjectoptional

EndCustomerobjectoptional

PurchItemsobjectoptional

MerchIDintegeroptional

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ACH/Combo' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "ChargeDetails": {
      "AccountNumber": "878460000256",
      "RoutingNumber": "211274515",
      "Amount": 10.25,
      "AccountType": 1
    },
    "AcctHolder": {
      "Firstname": "Sally",
      "Lastname": "Smith",
      "Company": "",
      "Title": "",
      "Url": "",
      "BillIngAdress": {
        "Address1": "123 Test Road",
        "Address2": "",
        "City": "Portland",
        "State": "ME",
        "ZIP": "04005",
        "Country": "USA"
      },
      "Email": "[e-mail]",
      "Phone": "8775558472"
    },
    "EndCustomer": {
      "Firstname": "Sally",
      "Lastname": "Smith",
      "Company": "",
      "Title": "",
      "Url": "",
      "BillIngAdress": {
        "Address1": "123 Test Road",
        "Address2": "",
        "City": "Portland",
        "State": "ME",
        "ZIP": "04005",
        "Country": "USA"
      },
      "Email": "[e-mail]",
      "Phone": "8775558472"
    },
    "PurchItems": {
      "ServiceDescrip": "FROM API TESTER",
      "ClientRefID": "12456AA",
      "RPGUID": "3d3424a6-c5f3-4c28"
    },
    "MerchID": 1
  }'

200

200

{
  "ACHTransaction_ComboResult": {
    "AuthID": "69017501",
    "ConsentID": 1247,
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "TxID 1381 Approved and ConsentID 1247 Created",
    "TxApproved": true,
    "TxID": 1381,
    "uniqueTranID": "16790131F349BCBA"
  }
}

Successful ACH Combo Sale and Consent transaction

Apply credit to an ACH transaction

post

Header parameters

SessKeystringrequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

TxIDintegeroptional

Example: 2

CreditAmountnumber · floatoptional

Example: 15.25

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ACH/ApplyCredit' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "TxID": 2,
    "CreditAmount": 15.25
  }'

200

200

{
  "ACH_ApplyCreditResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "APPROVED 67210758 TXID 000041",
    "TxApproved": true,
    "TxID": 41
  }
}

Successful application of credit to the ACH transaction

Process payment with ACH annual consent

post

Header parameters

SessKeystringrequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

ConsentIDintegeroptional

Example: 21

ProcessAmountnumber · floatoptional

Example: 5.1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ACH/ProcPayment' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "ConsentID": 21,
    "ProcessAmount": 5.1
  }'

200

200

{
  "ACHConsentAnnual_ProcPaymentResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "APPROVED 67210748 TXID 000035",
    "TxApproved": true,
    "TxID": 72,
    "uniqueTranID": "16790131F349BCBA"
  }
}

Successful processing of ACH consent payment

Void an ACH transaction

post

Header parameters

SessKeystringrequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-Typestringrequired

Example: application/json

Acceptstringrequired

Example: application/json

Body

TxIDintegeroptional

Example: 35

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://easypay5.com/APIcardProcREST/v1.0.0/ACH/Void' \
  --header 'SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
    "TxID": 35
  }'

200

200

{
  "ACHTransaction_VoidResult": {
    "AuthID": "67210748",
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOK": true,
    "RespMsg": "VOID APPROVED 67210748 TXID 35",
    "TxApproved": true,
    "TxID": 35
  }
}

Successful voiding of the ACH transaction