Skip to main content
Checks

Manage check stop

In this tutorial, you'll learn how to submit check stop requests for reconciliation and positive pay. By the end of this tutorial, you will know how to:

  • Submit check stop with escheatment data request
  • Submit check stop without escheatment data request

Before you begin

To submit check stop and revoke requests, you need the following: 

  • A registered and fully onboarded Developer Account on the J.P. Morgan Payments Developer Portal. 
  • An active project that provides you with the credentials used to make a request.  

Single stop payment request

Use the following example to submit a stop payment request for a single check by providing required details such as account number and check number. To do this, call a POST request to the /checks/stop endpoint.

Example: single stop payment request
Json
{
  "debtor": {
    "accountNumber": "123456",
    "financialInstitutionId": {
      "id": "021000021",
      "idType": "USABA"
    }
  },
  "type": "SINGLE",
  "check": {
    "checkNumber": "123456666"
  },
  "stopReason": "CHECKS_LOST"
}

Range stop payment request

Use the following example to submit a request to revoke stop payments for a range of checks. Specify the starting and ending check numbers to remove stop payment instructions for all checks within that range. To do this, call a POST request to the /checks/stop endpoint.

Example: range stop payment request
Json
{
  "debtor": {
    "accountNumber": "1234567890",
    "financialInstitutionId": {
      "id": "021000021",
      "idType": "USABA"
    }
  },
  "type": "RANGE",
  "check": {
    "checkRange": {
      "start": "10020",
      "end": "10030"
    }
  },
  "stopReason": "CHECKS_LOST"
}

Single stop payment request with full details

Use the following example to submit a stop payment request for a single check by providing all details such as account number, check number, amount, and payee information. To do this, call a POST request to the /checks/stop endpoint.

Example: single stop payment request with full details
Json
{
  "debtor": {
    "accountNumber": "1234567890",
    "financialInstitutionId": {
      "id": "021000021",
      "idType": "USABA"
    }
  },
  "type": "SINGLE",
  "check": {
    "checkNumber": "123456666"
  },
  "stopReason": "CHECKS_LOST",
  "checkAmount": {
    "currency": "CAD",
    "amount": "100.00"
  },
  "payees": [
    {
      "name": "John Doe",
      "priority": 1
    },
    {
      "name": "ELITE CORP",
      "priority": 2
    },
    {
      "name": "ACME INC",
      "priority": 3
    }
  ]
}

Single stop payment request with payee information

Use the following example to submit a stop payment request for a single check by providing only the payee information. To do this, call a POST request to the /checks/stop endpoint.

Example: single stop payment request with payee only
Json
{
  "debtor": {
    "accountNumber": "1234567890",
    "financialInstitutionId": {
      "id": "021000021",
      "idType": "USABA"
    }
  },
  "type": "SINGLE",
  "check": {
    "checkNumber": "123456666"
  },
  "stopReason": "CHECKS_LOST",
  "payees": [
    {
      "name": "John Doe",
      "priority": 1
    },
    {
      "name": "ELITE CORP",
      "priority": 2
    },
    {
      "name": "ACME INC",
      "priority": 3
    }
  ]
}

Single stop payment request with specific amount

Use the following example to place a stop request for a single check by providing the exact check amount. This approach ensures that only the check with the specified amount is stopped, even if you do not have other details such as the check number or payee information. To do this, call a POST request to the /checks/stop endpoint.

Example: single stop payment request with specific amount
Json
{
  "debtor": {
    "accountNumber": "1234567890",
    "financialInstitutionId": {
      "id": "021000021",
      "idType": "USABA"
    }
  },
  "type": "SINGLE",
  "check": {
    "checkNumber": "123456666"
  },
  "stopReason": "CHECKS_LOST",
  "checkAmount": {
    "currency": "CAD",
    "amount": "100.00"
  }
}
  • For more information about check stop and revoke, see Check stop and revoke overview.
  • For more information about status responses and error codes supported by the Checks API, see Error codes.
  • For more information about check stop and revoke resources, see Resources.