Payment Methods

POST /validate_ach_payment_method

Changed on

This endpoint can be used to verify an ACH payment method to confirm the bank account is valid and belongs to the consumer. To verify a bank account is valid, pass the following parameters into the request:<ul><li><code>ach_aba_pii</code></li><li><code>ach_account_pii</code></li></ul> If successful, the response will include a <code>verification_response</code> and an <code>account_response_code</code> combination that indicates the level of risk. For more information on these combinations, see ACH Verification Services.

Request

  • Base URL
    https://api.paynearme-sandbox.com/json-api
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://login.paynearme.com/oauth/token
    • or API key in query parameter signature

Request body

site_identifierstring required

Identifies your client site.

timestampstring required

The Unix Epoch time of the call

versionstring required

The version of the API. This version must match the version associated with your API key pair.

signaturestring

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

NOTE: This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.

ach_aba_piistring

The 9-digit ABA/routing number to verify.

ach_account_piistring

The account number of the bank account.

Example request

{
  "ach_aba_pii": "122105278",
  "ach_account_pii": "0000000016"
}

Response

Payment Method Valid

OR

Example response

{
  "giact": {
    "verification_response": "6",
    "account_response_code": "12"
  }
}

Changes

    • breaking

      the request property timestamp became required

    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    7 more changes in this revision