ACH

ACH

Verifications ACH resource.

Methods

POST

Verifies an ACH payment instrument.

Request

Copied!
{
 "type": "object",
 "properties": {
  "merchant": {
   "type": "object",
   "properties": {
    "entity": {
     "type": "string"
    },
    "mcc": {
     "type": "string"
    },
    "paymentFacilitator": {
     "type": "object",
     "properties": {
      "pfId": {
       "type": "string"
      },
      "isoId": {
       "type": "string"
      },
      "subMerchant": {
       "type": "object",
       "properties": {
        "merchantId": {
         "type": "string"
        },
        "name": {
         "type": "string"
        },
        "street": {
         "type": "string"
        },
        "city": {
         "type": "string"
        },
        "state": {
         "type": "string"
        },
        "countryCode": {
         "type": "string"
        },
        "postalCode": {
         "type": "string"
        },
        "taxId": {
         "type": "string"
        }
       },
       "required": [
        "merchantId",
        "name",
        "street",
        "city",
        "countryCode",
        "postalCode"
       ]
      }
     },
     "required": [
      "pfId",
      "subMerchant"
     ]
    }
   },
   "required": [
    "entity"
   ]
  },
  "paymentInstrument": {
   "oneOf": [
    {
     "type": "object",
     "properties": {
      "type": {
       "type": "string"
      },
      "accountType": {
       "type": "string"
      },
      "accountNumber": {
       "type": "string"
      },
      "routingNumber": {
       "type": "string"
      },
      "companyName": {
       "type": "string"
      },
      "billToAddress": {
       "type": "object",
       "properties": {
        "firstName": {
         "type": "string"
        },
        "lastName": {
         "type": "string"
        },
        "address1": {
         "type": "string"
        },
        "address2": {
         "type": "string"
        },
        "address3": {
         "type": "string"
        },
        "city": {
         "type": "string"
        },
        "region": {
         "type": "string"
        },
        "postalCode": {
         "type": "string"
        },
        "countryCode": {
         "type": "string"
        },
        "telephoneNumber": {
         "type": "string"
        }
       },
       "required": [
        "firstName",
        "lastName",
        "address1",
        "city",
        "region",
        "postalCode",
        "countryCode",
        "telephoneNumber"
       ]
      }
     },
     "required": [
      "type",
      "accountType",
      "accountNumber",
      "routingNumber",
      "billToAddress"
     ]
    }
   ]
  },
  "transactionReference": {
   "type": "string"
  }
 },
 "required": [
  "merchant",
  "paymentInstrument",
  "transactionReference"
 ]
}

Responses

Examples

POST
 Successful account verification outcome.
View
POST
 Refused account verification outcome.
View
post
 Successful account verification outcome.
POSThttps://try.access.worldpay.com/verifications/accounts/ach
Copied!
{
  "Authorization": "Basic Auth",
  "Content-Type": "application/vnd.worldpay.verifications.accounts-v5+json",
  "Accept": "application/vnd.worldpay.verifications.accounts-v5+json"
}
Copied!
{
  "merchant": {
    "entity": "default"
  },
  "transactionReference": "1234567",
  "paymentInstrument": {
    "type": "bankAccountUS",
    "accountType": "corporateSavings",
    "accountNumber": "1234567890",
    "routingNumber": "011400495",
    "companyName": "companyName",
    "billToAddress": {
      "firstName": "John",
      "lastName": "Smith",
      "address1": "address1",
      "address2": "address2",
      "address3": "address3",
      "city": "city",
      "region": "state",
      "postalCode": "postalCode",
      "countryCode": "US",
      "telephoneNumber": "4085551212"
    }
  }
}

201

Copied!
{
  "outcome": "verified",
  "checkedAt": "2021-09-27T18:02:16.475Z",
  "_links": {
    "curies": [
      {
        "name": "verifications",
        "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}",
        "templated": true
      }
    ]
  }
}