ACH Payment API

ACH Payment API

POST /ach/payments

Customers can pay ACH payments by phone call i.e., CBP, or an e-check from any online portal i.e., ICA. Check details can be stored for future use.

Headers

PARAMETER DESCRIPTION
gpsToken Token obtained in response to merchant authentication API for e-check.
Content-Type Content type.

Available values : application/json

Default value : application/json

Request

{
    "channel": "GPS",
    "amount": "37.00",
    "requestType": "check",
    "isSaveCheck": "Y",
    "routingNumber": "021300912",
    "accountNumber": "30733816",
    "accountType": "S",
    "checkType": "P",
    "sessionId": "{{$timestamp}}",
    "firstName": "Alakesh",
    "lastName": "Das",
    "addressOne": "Kestopur",
    "addressTwo": "KOLKATA",
    "city": "Washington",
    "state": "DC",
    "zip": "20008",
    "phoneNumber": "9831099948",
    "clientRequestId": "{{$timestamp}}",
    "merchantId": "{{icaSubMerchantId}}",
    "currency": "USD",
    "achType": "ICA",
    "email": "sriramk@utilli.com",
    "customerNumber": "000210130323"
  }

Parameters

NAME DESCRIPTION
Channel String    
Example: GPS    
Payment channel used.
Amount Number       
Example: 10.99    
Amount of the transaction.
Fee Number  
Example: 1.05  
Applicable only for the convenience fee model.
Request Type String  
Type of the payment request.  
Possible values are:
  • "check" is passed when making the payment using a check.
  • "token" is passed when making the payment using the saved check.
isSavecheck Boolean  
Example: Y  
To save customer's check details for future use. Possible values are:  
  • "Y" to save check details
  • "N" to not check details
Routing Number String     
Example:125675432  
Bank routing number.
Optional field if Request Type is "token".
Account Number String  
Example:12567543  
Bank account number.
Optional field if Request Type is "token".
Account Type String  
Example: S  
Identifies if the account type is Checking or Savings. Possible values are:  
  • “C” for Checking
  • "S" for Savings
Check Type String  
Example: P  
Identifies the check type is Personal or Company. Possible values are   
  • “P” for Personal
  • “C” for Company
Session ID String      
Timestamp, on which the payment was made.
First Name String  
Example: Jane     
Customer billing first name.
Last Name String  
Example: O' Calloway  
Customer billing first name.
Address One String
Example: 1234 Line Ave S.     
Customer billing address, first line.
Address Two String
Example: Ste 602   
Customer billing address, second line.
City String  
Example: Atlanta
City of the address.
State  String  
Example: Florida
The state of the address.
Zip String   
Example:20008  
Zip code of the address.
Phone Number String  
Example: 9897767787  
Customer's phone number.
The maximum length is 10 excluding country code. 
Client Request ID String       
The unique identifier of the transaction generated by the API consumer.
Merchant ID          String        
Identifier of ACH provided by Monay GPS.
Currency String  
Example: USD  
The currency of the payment. 
ACH Type String  
Possible values are:  
  • "ICA" for Internet check acceptance.
  • "CBP" for Check by phone.
Email String   
Example: abc.1234@monay.com
The customer's email address. 
Customer Number String   
Example:000210130323 
Length:12  
Unique identifier of customer assigned by the sub-merchant.

Response

{
    "timeStamp": "1668517501842",
    "clientRequestId": "1668517502",
    "statusDesc": "success",
    "statusCode": "200",
    "transactionId": "68558483070",
    "orderId": "R-98303e39-2eb6-4f0c-8dca-1d9708d31e69",
    "token": "76e53238-595c-4d21-9cf4-6cf99356a6329dc0f653-5668-42e8-b71f-cb2446259845"
}

Response Codes

Code Description
200 Success Response
400 The request cannot be validated.
401 The request cannot be authenticated or was submitted with the wrong credentials.


ACH Payment Reversal API

POST /ach/payments/reversal/

ACH Payment Reversal API will be called when a customer requests a return or void of an ACH transaction from the Monay GPS portal. If the reversal is requested before 5 PM EST, it will be void otherwise it will be a return payment. A customer can request a return within 90 days of the payment.

Note: ACH payment reversal is embedded in the Monay GPS portal. When a user requests a reversal ACH Payment Reversal API will be called.

Headers

Parameter Description
gpsToken Token obtained in response to merchant authentication API for e-check.
Content-Type Content type.

Available values : application/json

Default value : application/json

Request

{ 
    "merchantId": "{{icaSubMerchantId}}", 
    "channel": "GPS", 
    "clientRequestId": "{{icaClientRequestId}}", 
    "requestType": "return"
}

 Parameters

Name Description 
Merchant ID String        
Identifier of ACH provided by Monay GPS.
Channel  String  
Example: GPS  
Payment channel used.
Client Request ID String       
The unique identifier of the transaction generated by the API consumer.
Request Type  String  
The payment request status. Possible values are:  
  • Void
  • Return

Response

{
    "timeStamp": "1668518110463",
    "clientRequestId": "f8a4e71e-a557-49c9-80df-ef2b1dac82ee",
    "statusDesc": "success",
    "statusCode": "200",
    "transactionId": "69907190042",
    "orderId": "R-39ad4435-5349-4da3-bef9-73e48c3411e9",
    "token": null
}

Response Code

Code Description
200 Success Response
400 The request cannot be validated.
401 The request cannot be authenticated or was submitted with the wrong credentials.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.