ACHCREDIT

ACHCREDIT enables a credit to be made to a customer. The merchant account on record will be debited.

Successful requests will be indicated with a 2xx HTTP response code and the Approved attribute set to 'true'.

NOTE

It is possible to receive an HTTP 2xx response code indicating that the request was successfully received, understood, and processed at the HTTP protocol level, but still have the Approved attribute set to false. (A 2xx response code with an Approved attribute set to false means the server successfully handled the request itself; however the actual business or application logic determined that the request was not approved).

Available Functions

Perform a 'achcredit' transaction

POST, /v0/transaction/achcredit

REQUEST Object Attributes

View REQUEST Object Attributes

achCreditTable

Attribute	Data Type	Description	Required
Amount	object	Amount Object	True
Total	decimal	Total Transaction Amount Total is aKey/Value of the "Amount" Object	True
Currency	string	ISO 3-letter currency code Currency is aKey/Value of the "Amount" Object	True
PaymentMethod	object	Transaction Payment Method	True
ACH	object	ACH Info ACH is aKey/Value of the "PaymentMethod" Object	True
BankRoutingNumber	string	Bank routing number of the customer BankRoutingNumber is aKey/Value of the "PaymentMethod" > "ACH" Object	True
AccountNumber	string	Account number of the customer AccountNumber is aKey/Value of the "PaymentMethod" > "ACH" Object	True
AchAccountType	string	ACH Account Types AchAccountType is aKey/Value of the "PaymentMethod" > "ACH" Object	True
CustomerName	string	Name of Customer to be Credited CustomerName is aKey/Value of the "PaymentMethod" > "ACH" Object	True
CustomerIdentifier	string	Identification Value of the Customer CustomerIdentifier is aKey/Value of the "PaymentMethod" > "ACH" Object	False
PaymentRelatedInformation	string	Additional, discretionary customer payment information such as address, etc. PaymentRelatedInformation is aKey/Value of the "PaymentMethod" > "ACH" Object	False
CheckNumber	string	Customer Check Number CheckNumber is aKey/Value of the "PaymentMethod" > "ACH" Object	False
EffectiveDate	string	Date for which the customer should be credited (YYYY-MM-DD) Effective Date is aKey/Value of the "PaymentMethod" > "ACH" Object	True
Token	object	Indicates the Token ID as the payment method Token is aKey/Value of the "PaymentMethod" Object	True
TokenID	ksuid	Token ID TokenID is aKey/Value of the "PaymentMethod" > "Token" Object	True
DataAction	string	Data Action	True
Detail	object	Transaction Details	False
MerchantData	object	Merchant Defined Transaction Data (supports 1 or more Merchant Defined Keys) MerchantData is aKey/Value of the "Detail" Object	False
MerchantDefinedKey1	string	Merchant - defined transaction data (field 1) MerchantDefinedKey1 is aKey/Value of the "Detail" > "MerchantData" Object	False
MerchantDefinedKey2	string	Merchant - defined transaction data (field 2) MerchantDefinedKey2 is aKey/Value of the "Detail" > "MerchantData" Object	False
TransactionEntry	object	See Transaction Entry Section (Information about transaction entry)	False

REQUEST Example

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/achcredit
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 25.50,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "ACH": {
            "BankRoutingNumber": "999999999",
            "AccountNumber": "01234567890123456",
            "AchAccountType": "PersonalChecking",
            "CustomerName": "Polly Paynetworx",
            "CustomerIdentifier": "A12345",
            "PaymentRelatedInformation": "123 Main Street, Van Alstyne, TX 75495, 999-999-9999",
            "CheckNumber": "5678",
            "EffectiveDate": "2012-04-21"
        }
    }
}'

REQUEST Example with Token Add request

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/achcredit
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 25.50,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "ACH": {
            "BankRoutingNumber": "999999999",
            "AccountNumber": "01234567890123456",
            "AchAccountType": "PersonalChecking",
            "CustomerName": "Polly Paynetworx",
            "CustomerIdentifier": "A12345",
            "PaymentRelatedInformation": "123 Main Street, Van Alstyne, TX 75495, 999-999-9999",
            "CheckNumber": "5678",
            "EffectiveDate": "2012-04-21"
        }
    },
    "DataAction": "token/add"
}'

REQUEST Example with Token ID

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/achcredit
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 25.50,
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Token": {
            "TokenID": "1wxhkFx6JoPktNoPYpgFpSGmTMF"
        },
        "ACH": {
            "AchAccountType": "PersonalChecking",
            "CustomerName": "Polly Paynetworx",
            "CustomerIdentifier": "A12345",
            "PaymentRelatedInformation": "123 Main Street, Van Alstyne, TX 75495, 999-999-9999",
            "CheckNumber": "5678",
            "EffectiveDate": "2012-04-21"
        }
    }
}'

RESPONSE Object Attributes

View RESPONSE Object Attributes

defaultResponseTable

Attribute	Data Type	Description
TransactionID	ksuid	Unique transaction lifetime system ID
EventID	ksuid	Unique transaction event system ID
RequestID	ksuid	Unique transaction request system ID
Approved	boolean	Request approval indicator
Token	object	Request approval indicator
TokenID	ksuid	Token ID TokenID is aKey/Value of the "Token" Object
TokenName	string	Unique Name of the Token Used TokenName is aKey/Value of the "Token" Object

RESPONSE Example

JSON Response Object

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "ResponseText": "ACH request submitted successfully",
  "Approved": true
}

RESPONSE Example with Token Add request

JSON Response Object

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "ResponseText": "ACH request submitted successfully",
  "Approved": true,
  "Token": {
    "TokenID": "1wxhkFx6JoPktNoPYpgFpSGmTMF",
    "TokenName": "*************3456"
  }
}

RESPONSE Example with Token ID

JSON Response Object

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "ResponseText": "ACH request submitted successfully",
  "Approved": true,
  "Token": {
    "TokenID": "1wxhkFx6JoPktNoPYpgFpSGmTMF",
    "TokenName": "*************3456"
  }
}