New API Version | Last Updated: 27 June 2024 | Change Log

ACH verification

ACH verification gives you the ability to perform a verification against a US bank account.

ACH verification request

POST https://try.access.worldpay.com/achVerifications


Example request body

ACH verification requests with mandatory fields only:

{
  "merchant": {
    "entity": "MindPalaceLtd"
  },
  "transactionReference": "1234567",
  "paymentInstrument": {
    "type": "bankAccountUS",
    "accountType": "checking",
    "accountNumber": "1234567890",
    "routingNumber": "011400495",
    "billToAddress": {
      "firstName": "John",
      "lastName": "Smith",
      "address1": "address1",
      "city": "city",
      "region": "state",
      "postalCode": "postalCode",
      "countryCode": "US",
      "telephoneNumber": "4085551212"
    }
  }
}

Descriptions of your mandatory ACH verification request parameters:

ParameterRequired?Description
merchant.entityDirect your verification to assist with billing, reporting and reconciliation. For more information contact your Relationship Manager. For full object descriptions see our API Reference.
transactionReferenceA unique reference generated by you that is used to identify a payment throughout its lifecycle. For full object descriptions see our API Reference.
paymentInstrumentAn object that contains your customer's payment details. For full object descriptions see our API Reference.
paymentInstrument.typeAn object that contains your customer's payment type. The only allowed value is:
  • bankAccountUS
paymentInstrument.accountTypeAn object that contains your customer's payment account type. For Personal Account possible values:

  • checking
  • savings
For Corporate Account possible values:
  • corporate
  • corporateSavings
paymentInstrument.accountNumberAn object that contains your customer's bank account number.
paymentInstrument.routingNumberAn object that contains your customer's bank routing number.
paymentInstrument.companyNameAn object that contains your customer's company name. This is a mandatory field for Corporate Account and must not be supplied for Personal Account.
paymentInstrument.billToAddressAn object containing the bill to address information. Mandatory fields include:
  • address1
  • city
  • region
  • postalCode
  • countryCode
  • telephoneNumber
billToAddress.firstNameAn object that contains your customer's first name. This is a mandatory field for Personal Account.
billToAddress.lastNameAn object that contains your customer's last name. This is a mandatory field for Personal Account.

Optional fields in an ACH verification request

Optional fields and descriptions

ACH verification requests with optional and mandatory fields:

{
  "merchant": {
    "entity": "MindPalaceLtd"
  },
  "transactionReference": "1234567",
  "paymentInstrument": {
    "type": "bankAccountUS",
    "accountType": "checking",
    "accountNumber": "1234567890",
    "routingNumber": "011400495",
    "billToAddress": {
      "firstName": "John",
      "lastName": "Smith",
      "address1": "address1",
      "address2": "address2",
      "address3": "address3",
      "city": "city",
      "region": "state",
      "postalCode": "postalCode",
      "countryCode": "US",
      "telephoneNumber": "4085551212"
    }
  }
}

Descriptions of your optional ACH verification request parameters:

ParameterRequiredDescription
paymentInstrument.billToAddressAn object containing the bill to address information. Optional fields includes:
  • address2
  • address3
billToAddress.firstNameAn object that contains your customer's first name. This is an optional field for Corporate Account.
billToAddress.lastNameAn object that contains your customer's last name. This is an optional field for Corporate Account.

ACH verification response

In your response is a 201 HTTP response code and the historic outcome of the verification.

outcome:

  • verified
  • not verified
{
   "outcome":"verified",
   "checkedAt":"2021-09-27T18:02:16.475Z",
   "_links":{
      "cardVerifications: verification":{
         "href":"https://try.access.worldpay.com/cardVerifications/{resource}"
      }
   }
}