Debit Block Detection

Orum’s debit block detection enables customers to determine whether or not a debit block has been placed on an account. The goal of this functionality is to inform you when there is an account that cannot be debited, so that you can inform your end users that an action is required in order to make the account debitable.

In order to use this endpoint, it is required that you have previously called the Account Status endpoint at some point in the past. Upon calling the debit block endpoint, Orum will debit 1 penny and credit 1 penny to the specified account. If the debit is successful and a return hasn’t occurred within 2 business days of the Effective Entry Date, Orum will respond by notifying you that there is not a debit block on the account. In the event that there is a debit block, and the account cannot be debited, you will be notified via webhook that there is a debit block on the account. In the event that there is a return for a reason other than a debit block, Orum will notify you as well.

To check for a debit block, you must first hit the Account Status endpoint. Once you have an Orum generated unique ID for the verified account from the Account Status API response, you can call the Debit Status endpoint to determine if there is a debit block on the account.

Debit Status

When checking for debit blocks, you may receive the following debit statuses:

Note: “pending” and “valid” are intermediary statuses. If a return occurs after two business days, it is possible that a debit status will cycle from “valid” to “blocked” or “failed”, for up to 60 days.

Examples

POST cURL:

curl --location --request POST 'https://api.orum.io/verify/accounts/212d554a-e1a8-4d38-a13a-3445518abe5a/debits' \
--header 'X-API-KEY: ******' \
--header 'Orum-Version: v2022-09-21' \
--header 'Authorization: ••••••' 

POST Response Body:

{
   "account": {
       "id": "212d554a-e1a8-4d38-a13a-3445518abe5a",
       "account_number": "0123456789",
       "routing_number": "021000021",
       "account_holder_name": "Clothing Depot",
       "verification_status": "valid",
       "estimated_verification_date": "2024-05-21T00:00:00Z",
       "debit_status": "pending",
       "created_at": "2024-05-21T19:32:50.457704Z",
       "updated_at": "2024-05-21 13:33:16.890744Z"
   }
}

Sample Webhook Event

{
    "event_id": "dfd02ada-5db7-48fb-a22a-ce24558e53c1",
    "event_type": "verify_account_updated",
    "created_at": "2024-05-27T03:59:07.990744Z",
    "event_data": {
        "account": {
            "id": "212d554a-e1a8-4d38-a13a-3445518abe5a",
            "account_number": "0123456789",
            "routing_number": "021000021"
            "account_holder_name": "Clothing Depot",
            "verification_status": "valid"
            "estimated_verification_date": "2024-05-21T00:00:00Z",
            "debit_status": "blocked",
            "debit_status_reason": "unauthorized_transfer",
            "created_at": "2024-05-21T19:32:50.457704Z",
            "updated_at": "2024-05-27T03:59:06.890744Z"
        }
    }
}