Skip to main content
Embedded Payments

Notification payload samples with OAuth

Take a look at these payload examples relating to available notifications in Embedded Payments.

Onboarding examples

Client status - New client

Header:

New client - Header
Json
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

New client - Body
Json
{
  "notificationId": "2f10347a-8ceb-4036-aabc-4cd8dfea4e8c",
  "platformId": "6019582220",
  "notificationType": "EntityOnboardingNotification",
  "notificationSubType": "EntityOnboardingV2",
  "messageCreateTimestamp": "2025-05-29T12:20:53.458211217Z",
  "subscriptionId": "651f1cab-8076-4e41-a59e-361b0e92bbdc",
  "callbackURL": "https://clienturl.com/api/v1/notification",
  "entityOnboardingNotification": {
    "entityOnboardingV2": {
      "status": "NEW",
      "id": "3002042389",
      "hasOutstandingInformation": "true",
      "customerIdentityStatus": "NEW"
    }
  }
}

Client status - Review in progress

Header:

Review in progress - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Review in progress - Body
Json
{
  "notificationId": "2f10347a-8ceb-4036-aabc-4cd8dfea4e8c",
  "platformId": "6019582220",
  "notificationType": "EntityOnboardingNotification",
  "notificationSubType": "EntityOnboarding",
  "messageCreateTimestamp": "2025-05-29T12:20:53.458211217Z",
  "subscriptionId": "651f1cab-8076-4e41-a59e-361b0e92bbdc",
  "callbackURL": "https://clienturl.com/api/v1/notification",
  "entityOnboardingNotification": {
    "entityOnboardingV2": {
      "status": "REVIEW_IN_PROGRESS",
      "id": "3002042389",
      "hasOutstandingInformation": "false",
      "customerIdentityStatus": "REVIEW_IN_PROGRESS"
    }
  }
}

Client status - Information requested

Header:

Information requested - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Information requested - Body
Json
{
  "notificationId": "2f10347a-8ceb-4036-aabc-4cd8dfea4e8c",
  "platformId": "6019582220",
  "notificationType": "EntityOnboardingNotification",
  "notificationSubType": "EntityOnboarding",
  "messageCreateTimestamp": "2025-05-29T12:20:53.458211217Z",
  "subscriptionId": "651f1cab-8076-4e41-a59e-361b0e92bbdc",
  "callbackURL": "https://clienturl.com/api/v1/notification",
  "entityOnboardingNotification": {
    "entityOnboardingV2": {
      "status": "INFORMATION_REQUESTED",
      "id": "3002042389",
      "hasOutstandingInformation": "true",
      "customerIdentityStatus": "INFORMATION_REQUESTED"
    }
  }
}

Client status - Approved

Header:

Approved - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Approved - Body
Json
{
  "notificationId": "2f10347a-8ceb-4036-aabc-4cd8dfea4e8c",
  "platformId": "6019582220",
  "notificationType": "EntityOnboardingNotification",
  "notificationSubType": "EntityOnboarding",
  "messageCreateTimestamp": "2025-05-29T12:20:53.458211217Z",
  "subscriptionId": "651f1cab-8076-4e41-a59e-361b0e92bbdc",
  "callbackURL": "https://clienturl.com/api/v1/notification",
  "entityOnboardingNotification": {
    "entityOnboardingV2": {
      "status": "APPROVED",
      "id": "3002042389",
      "hasOutstandingInformation": "false",
      "customerIdentityStatus": "APPROVED"
    }
  }
}

Account examples

ACCOUNT_CREATED

Header:

Account created - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Account created - Body
Json
{ 
  "notificationId": "34feecd2-dfb9-4063-95ad-a20edd844554", 
  "platformId": "0001006723", 
  "notificationType": "AccountUpdateNotification", 
  "notificationSubType": "AccountCreated", 
  "messageCreateTimestamp": "2025-03-11T16:06:01.171450525Z", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "accountUpdateNotification": { 
    "accountCreated": { 
      "clientId": "1000020694", 
      "id": "acbd907ca11d451dad5b5cbd46ea542a", 
      "type": "LIMITED_DDA_PAYMENTS", 
      "label": "MAIN", 
      "state": "OPEN" 
      "createdAt": "2025-03-10T17:07:11.069Z", 
      "paymentRoutingInformation": { 
        "accountNumber": "20000058715834", 
        "country": "US", 
        "routingInformations": [ 
          { 
            "type": "USABA", 
            "value": "1000222" 
          } 
        ] 
      } 
    } 
  } 
}

ACCOUNT_OVERDRAWN

When your accounts go into negative balance, we will send notifications to inform you after certain number of days (such as 30, 59, or 60 days) an account remains in a negative balance.

  • effectiveDate: The specific date when event occurred. 
  • ledgerBalance: The current balance of account.
  • daysOverdrawn: The number of days account remains in negative balance (such as 30, 59, or 60 days).

Header:

Account overdrawn - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Account overdrawn - Body
Json
{ 
  "notificationId": "167cff8b-a582-4385-abe0-81ab857b1cc3", 
  "platformId": "0001006723", 
  "notificationType": "AccountUpdateNotification", 
  "notificationSubType": "AccountOverdrawn", 
  "messageCreateTimestamp": "2025-03-11T16:31:39.864781075Z", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "accountUpdateNotification": { 
    "accountOverdrawn": { 
      "clientId": "1000020694", 
      "id": "acbd907ca11d451dad5b5cbd46ea542a", 
      "state": "OPEN" 
      "overdraftStatus": { 
        "effectiveDate": "2025-03-10", 
        "ledgerBalance": "1200", 
        "daysOverdrawn": 30 
      } 
    } 
  } 
}

ACCOUNT_CLOSED

Header:

Account closed - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Account closed - Body
Json
{ 
  "notificationId": "2b9454a8-5925-4b3f-8022-fadf441a4c01", 
  "platformId": "0001006723", 
  "notificationType": "AccountUpdateNotification", 
  "notificationSubType": "AccountClosed", 
  "messageCreateTimestamp": "2025-03-13T12:00:42.249334914Z", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "accountUpdateNotification": { 
    "accountClosed": { 
      "clientId": "1000020694", 
      "id": "acbd907ca11d451dad5b5cbd46ea542a", 
      "type": "DDA", 
      "label": "MAIN", 
      "state": "CLOSED" 
      "createdAt": "2025-03-12T16:10:37.940Z", 
      "paymentRoutingInformation": { 
        "accountNumber": "20000058715834", 
        "country": "US", 
        "routingInformations": [ 
          { 
            "type": "USABA", 
            "value": "1000222" 
          } 
        ] 
      } 
    } 
  } 
}

Transaction examples

TRANSACTION_COMPLETED

Header:

Transaction completed - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Transaction completed - Body
Json
{
  "notificationId": "8d6d6de9-d690-4bec-8662-514ba72439e2",
  "platformId": "0001006723",
  "notificationType": "TransactionUpdateNotification",
  "notificationSubType": "TransactionCompleted",
  "messageCreatedTimestamp": "2022-12-22T13:27:24.215223Z",
  "callbackURL": "https://clienturl.com/api/v1/notification",
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256",
  "transactionUpdateNotification": {
    "transactionCompleted": {
      "clientId": "1000020694",
      "id": "3ZJUCLKH3c1sIWk",
      "transactionReferenceId": "2hjsa998931301jkj",
      "type": "ACH",
      "amount": "20.88",
      "currency": "USD",
      "paymentDate": "2024-04-23",
      "ledgerBalance": "10.00",
      "debtorAccountId": "acbd907ca11d451dad5b5cbd46ea542a",
      "recipientId": "d9dab78e-e366-4dde-ac9d-fb3f9d48437b",
      "status": "COMPLETED"
    }
  }
}

TRANSACTION_COMPLETED RETURN

In some cases when you send an ACH payment, the payment can be returned by the receiving party's bank. This means that the ACH payment has technically completed, but will be returned after a period of time.

In this eventuality, you receive two notifications:

When you send the payment, you receive a TRANSACTION_COMPLETED event to show that the ACH payment has been successfully sent.

When the ACH return is received from the receiving party's bank, you will receive a second TRANSACTION_COMPLETED event with type: "RETURN". ACH returns are typically received within 2 banking days, but may be up to 60 days later.

You can see in the below payload:

type: "RETURN" - which means the transaction is a return of the original payment into your account.

  • originatingId : The transaction ID of the original transaction.
  • originatingTransactionType : The type of payment originally requested.
  • transactionReferenceId : The transaction reference ID of payment originally requested.

If this repeatedly happens, or happens because your recipient's account has closed, you need to remove this recipient and add a new one for your client. ACH Return:

ACH return

Header:

ACH return - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Json
{
  "notificationId": "8d6d6de9-d690-4bec-8662-514ba72439e2",
  "platformId": "0001006723",
  "notificationType": "TransactionUpdateNotification",
  "notificationSubType": "TransactionCompleted",
  "messageCreatedTimestamp": "2022-12-22T13:27:24.215223Z",
  "callbackURL": "https://clienturl.com/api/v1/notification",
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256",
  "transactionUpdateNotification": {
    "transactionCompleted": {
      "clientId": "1000020694",
      "id": "3ZJUCLKH3c1sIWk",
      "transactionReferenceId": "2hjsa998931301jkj",
      "type": "RETURN",
      "amount": "20.88",
      "currency": "USD",
      "paymentDate": "2024-04-23",
      "ledgerBalance": "10.00",
      "originatingId": "cz5Dfr2bUwxqCCT",
      "originatingTransactionType": "ACH_PAYOUT",
      "memo": "ORIG CO NAME:AMAZON.CBROYT0DM ORIG ID:3215240102  TRACE#:021000022497667 EED:210112 IND ID:cz5Dfr2bUwxqCCT IND NAME:HELEN TRIESCH R02 - ACCOUNT CLOSED ORIGIN# 8623477186 ACH RETURN BLK# 012  TRN: 0122497667TC",
      "debtorAccountId": "acbd907ca11d451dad5b5cbd46ea542a",
      "recipientId": "d9dab78e-e366-4dde-ac9d-fb3f9d48437b",
      "status": "COMPLETED",
      "error": {
        "title": "Returned Payment",
        "contexts": [
          {
            "code": "11004",
            "message": "Account number specified has been closed on the bank of account's books"
          }
        ]
      }
    }
  }
}

TRANSACTION_COMPLETED (P2C)

Push to Card (P2C) payout notifications follow the same TRANSACTION_COMPLETED and TRANSACTION_FAILED event types, with the creditorAccountNumber field displaying a masked card number showing only the last 3 digits.

Json
{
  "eventId": "5125",
  "eventType": "TRANSACTION_COMPLETED",
  "resourceType": "TRANSACTIONS",
  "resourceObject": {
    "id": "kchDMSyoup",
    "clientId": "1000010400",
    "transactionReferenceId": "TestRefMap_DMS_091202",
    "type": "CARD",
    "debtorAccountId": "2dddf410b6db4f1ba9afa64e7cb7a8db",
    "recipientId": "c8dc77a2-890c-4f4e-b714-29ce0b5dda7b",
    "amount": "0.01",
    "currency": "USD",
    "status": "COMPLETED",
    "paymentDate": "2025-12-05",
    "ledgerBalance": "53.3",
    "debtorName": "Mary Sheen",
    "debtorAccountNumber": "...2050",
    "creditorAccountNumber": "...X447",
    "creditorName": "Mary K Sheen"
  }
}

TRANSACTION_FAILED_ACH

Header:

Transaction failed ACH - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Transaction failed ACH - Body
Json
{ 
  "notificationId": "cb8ad296-2b7f-4dc2-ad02-4be20148a08f", 
  "platformId": "0001006723", 
  "notificationType": "TransactionUpdateNotification", 
  "notificationSubType": "TransactionFailed", 
  "messageCreateTimestamp": "2025-03-13T10:56:20.156644882Z", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "transactionUpdateNotification": { 
    "transactionFailed": { 
      "clientId": "1000020694", 
      "id": "u57JFZm8JEMAPuji", 
      "transactionReferenceId": "UNPTestPay2211", 
      "type": "TRANSFER", 
      "amount": "1", 
      "currency": "USD", 
      "paymentDate": "2025-03-13", 
      "status": "REJECTED", 
      "debtorAccountId": "acbd907ca11d451dad5b5cbd46ea542a", 
      "creditorAccountId": "acbd907ca11d451dad5b5cbd46ea542a", 
      "error": { 
        "title": "Rejected Payment", 
        "contexts": [ 
          { 
            "code": "11017", 
            "message": "Transaction Forbidden" 
          } 
        ] 
      } 
    } 
  } 
}

TRANSACTION_CHANGE_REQUESTED

TRANSACTION_CHANGE_REQUESTED is a Notification of Change (NOC) event for transactions. It notifies you, as the sender of an ACH payment, that you must correct or change information related to the recipient’s bank account. In Embedded Payments, this means you must add your client's linked account details again with the corrected values provided in the NOC.

This does not mean the transaction has failed. In most cases, the transaction referred to in the notification has been successful, but the updated details must be added before long, or transactions to this account may start to fail.

You can see in the below payload:

  • correctedValues : The values that need to be changed. For example, routing information, account number, or individual name.
  • transactionReferenceId : The transactionReferenceId of the payment for which the NOC has been received.
  • message : Within the context object, the message tells you the reason for the NOC notification.

Transaction change requested

Header: 

Transaction change requested - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Transaction change requested - Body
Json
BODY 
{ 
  "notificationId": "8d6d6de9-d690-4bec-8662-514ba72439e2", 
  "platformId": "0001006723", 
  "notificationType": "TransactionUpdateNotification", 
  "notificationSubType": "TransactionChangeRequested", 
  "messageCreatedTimestamp": "2022-12-22T13:27:24.215223Z", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "transactionUpdateNotification": { 
    "transactionChangeRequested": { 
      "id": "19953590-8e1f-4c4c-ae74-3938db0873ed", 
      "transactionReferenceId": "zGbJTEJIcRBuc8i", 
      "recipientId": "85ba1569-a74f-4326-a938-2069991f1afd", 
      "changeDetails": { 
        "title": "Clearing Notification Of Change", 
        "contexts": [ 
          { 
            "code": "NARR", 
            "message": "C03 – Incorrect Routing Number and Incorrect DFI Account Number", 
            "correctedValues": [ 
              { 
                "value": "267184199", 
                "field": "account.routingInformation.routingNumber" 
              }, 
              { 
                "value": "1271271448", 
                "field": "account.number" 
              } 
            ] 
          } 
        ] 
      } 
    } 
  } 
}

Limit examples

THRESHOLD_LIMIT

For issued direct debits and balance management, you receive notifications based on preconfigured program-level limits set for each platform. Each platform has a maximum negative balance allowed across its program. There are three use cases for sending notifications:

  • Alert Percent: The lower-level limit that notifies the platform when it exceeds a specific percentage of its total negative balance allowance.
  • Restrict Percent: The upper-level limit, reached when the program limit is met. Transactions begin to fail at this point. The platform is responsible for working with users to address negative balances before reaching the maximum allowance.
  • Reset Percentages: Notifications triggered when platforms address negative balances. There are upper and lower reset percentages that send notifications once negative balances are resolved.
Threshold limit
Json
{
"header":   {
    "apiGatewayClientId" : "31590151",
    "callbackMessageType": "EMBEDDED_FINANCE_CLIENTS"
},
"payload":   {
    "eventId": "2039520235",
    "eventType": "THRESHOLD_LIMIT",  
    "resourceType":  "CLIENTS",
    "resourceObject": {
     "id": "100000234",
     "effectiveDate": "2024-09-09",
     "limitType": "AGGREGATE",
     "aggregateOverdrawn": {
              "amount": "-8000.00",
              "percent": "80",
              "maxAmount": "10000",
              "alertPercent": "80",
              "alertResetPercent": "70",
              "restrictPercent": "100",
              "restrictResetPercent": "90",
           }
       }
   }
}

The following provides a brief description of each field:

Threshold limit fields
Field Description Notes
amount                The current total negative balance for a platform's program. -
maxAmount The program-level maximum negative balance allowance. -
Percent The current percentage of the total program-level limit. amount divided by maxAmount.
alertPercent The percentage of the maximum negative balance where you receive a warning. If set to 80 and the maximum negative balance is $10,000, you will receive a notification when your negative balance reaches $8,000, notifying that you are approaching towards the set negative balance limit.

alertResetPercent

 The percentage of the maximum negative balance where you receive a notification after addressing negative balances below the lower limit threshold. If set to 70 and the maximum negative balance is $10,000, you will receive a notification when your negative balance drops below $7,000. This serves as a prompt to address the negative balance.
restrictPercent The percentage of the maximum negative balance where you are notified that the program-level limit has been exceeded and transactions begin to fail. If set to 100 and the maximum negative balance is $10,000, transactions will fail when your negative balance reaches $10,000. At this point, you must address the negative balance before you can process additional transactions. 
restrictResetPercent The percentage of the maximum negative balance where you receive a notification after addressing negative balances below the upper limit threshold. If set to 90 and the maximum negative balance is $10,000, you will receive a notification when your negative balance drops below $9,000 after you have addressed the negative balance, but still remain at risk of approaching maxAmount.

Recipient examples

RECIPIENT_ACCOUNT_VALIDATION

It alerts you when:

  • Microdeposits are received and the deposits are ready to validate. 
  • There are three days until the validation window expires.
  • The validation window has expired.

For Linked Account recipient types. If your client must go through the validation process involving microdeposits, this notification tells you that the small deposits have been made and your client can check their linked account and verify the amounts that have been received. 

Recipient ready for validation

Header:

Recipient ready for validation - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Recipient ready for validation - Body
Json
{ 
  "notificationId": "33c3fdb8-5fb9-461d-ac45-7b2aeaa652af", 
  "platformId": "0001006723", 
  "notificationType": "AccountUpdateNotification", 
  "notificationSubType": "RecipientAccountValidation", 
  "messageCreateTimestamp": "2025-03-12T12:37:11.941061450Z", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "accountUpdateNotification": { 
    "recipientAccountValidation": { 
      "id": "d9dab78e-e366-4dde-ac9d-fb3f9d48437b", 
      "type": " LINKED_ACCOUNT", 
      "status": "READY_FOR_VALIDATION", 
      "daysUntilExpiry": 10, 
      "clientId": "1000020694" 
    } 
  } 
}

Recipient ready for validation reminder

For Linked Account recipient types. If your client must go through the validation process involving microdeposits, this notification reminds you that 3 days have passed since the validation process began, and the chance to verify the small deposits will soon expire.

Header:

Recipient ready for validation reminder - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Recipient ready for validation - Body
Json
{ 
  "notificationId": "33c3fdb8-5fb9-461d-ac45-7b2aeaa652af", 
  "platformId": "0001006723", 
  "notificationType": "AccountUpdateNotification", 
  "notificationSubType": "RecipientAccountValidation", 
  "messageCreateTimestamp": "2025-03-12T12:37:11.941061450Z", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "accountUpdateNotification": { 
    "recipientAccountValidation": { 
      "id": "d9dab78e-e366-4dde-ac9d-fb3f9d48437b", 
      "type": " LINKED_ACCOUNT", 
      "status": "READY_FOR_VALIDATION", 
      "daysUntilExpiry": 10, 
      "clientId": "1000020694" 
    } 
  } 
}

RECIPIENT_READY_FOR_VALIDATION_EXPIRED

For Linked Account recipient types. If your client must go through the validation process involving microdeposits, this notification tells you that the window of time for validation has closed, and you must repeat the process of adding the linked account to validate again. 

Header:

Recipient ready for validation expired - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4", 
"signature": "<digital-signature>", 
"key-id": "fac1e103bf3343268fe1217211d08c39", 
"signingAlgorithm": "EC", 
"Authorization": "Bearer <token>", 
"Content-Type": "application/json"

Body:

Recipient ready for validation expired - Body
Json
{ 
  "notificationId": "33c3fdb8-5fb9-461d-ac45-7b2aeaa652af", 
  "platformId": "0001006723", 
  "notificationType": "AccountUpdateNotification", 
  "notificationSubType": "RecipientAccountValidation", 
  "messageCreateTimestamp": "2025-03-12T12:37:11.941061450Z", 
  "subscriptionId": "1b8bd237-0462-441c-b584-e3549b551256", 
  "callbackURL": "https://clienturl.com/api/v1/notification", 
  "accountUpdateNotification": { 
    "recipientAccountValidation": { 
      "id": "d9dab78e-e366-4dde-ac9d-fb3f9d48437b", 
      "type": "LINKED_ACCOUNT", 
      "status": "INACTIVE", 
      "daysUntilExpiry": 0, 
      "clientId": "1000020694" 
    } 
  } 
}

RECIPIENT_UPDATED

This notification tells you, as a sender of this ACH payment, that we updated the recipient's banking information after receiving a Notification of Change (NOC) transaction event.

The following provides a brief description of the updated fields:

recipient updated
Field Description
account The account values updated, such as routing number and account number (last four digits).
description This specifies the ACH transaction ID of the payment that received the NOC.

Header:

Recipient updated - Header
Plaintext
"correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4",
"signature": "",
"key-id": "fac1e103bf3343268fe1217211d08c39",
"signingAlgorithm": "EC",
"Authorization": "Bearer ",
"Content-Type": "application/json"

Body:

Recipient updated - Body
Json
{
  "notificationId": "9d6d2617-af28-40dd-8fbd-bd3c9d1cb725",
  "platformId": "6000000134",
  "notificationType": "AccountUpdateNotification",
  "notificationSubType": "RecipientUpdated",
  "messageCreateTimestamp": "2025-12-29T15:46:18.209804297Z",
  "subscriptionId": "4c41d545-36d1-4621-86fa-fa173852df2c",
  "callbackURL": "https://clienturl.com/api/v1/notification",
  "accountUpdateNotification": {
    "recipientUpdated": {
      "id": "d67b4396-7681-4e0c-87b7-f618910615c7",
      "clientId": "5007299123",
      "account": {
        "number": "1448",
        "routingInformations": [
          {
            "routingNumber": "267084199"
          }
        ]
      },
      "type": "RECIPIENT",
      "updatedAt": "2025-12-29T15:46:17.764053100Z",
      "description": "Received Notification Of Change on ACH transaction id - 38BwJemu1egGrWC"
    }
  }
}

Document examples

DOCUMENT_GENERATED

Header:

Plaintext
correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4",
"signature": "<digital-signature>",
"key-id": "fac1e103bf3343268fe1217211d08c39",
"signingAlgorithm": "EC",
"Authorization": "Bearer <token>",
"Content-Type": "application/json

Body:

Json
{
  "notificationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "platformId": "0005191231",
  "notificationType": "documentNotification",
  "notificationSubType": "DocumentGenerated",
  "notificationDescription": "Document generated successfully",
  "messageCreateTimestamp": "2026-04-02T10:30:00.000Z",
  "subscriptionId": "sub-9876-5432-1abc",
  "callbackURL": "https://client.example.com/webhooks/notifications",
  "documentNotification": {
    "documentGenerated": {
      "documentId": "7c6d9a9d-c49b-45b7-94e8-4f4b8f31b521",
      "documentType": "ACCOUNT_CONFIRMATION_LETTER",
      "parameters": {
        "accountId": "4d2f3a8c7b1e4f5ea92d3b6c8f11aa29"
      }
    }
  }
}

DOCUMENT_FAILED

Header:

Plaintext
correlation-id": "4e1d4e12-1d48-4548-961f-800ae3a84ef4",
"signature": "<digital-signature>",
"key-id": "fac1e103bf3343268fe1217211d08c39",
"signingAlgorithm": "EC",
"Authorization": "Bearer <token>",
"Content-Type": "application/json

Body:

Json
{
  "notificationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "platformId": "0005191231",
  "notificationType": "documentNotification",
  "notificationSubType": "DocumentFailed",
  "notificationDescription": "Document generation failed",
  "messageCreateTimestamp": "2026-04-02T10:31:00.000Z",
  "subscriptionId": "sub-9876-5432-1abc",
  "callbackURL": "https://client.example.com/webhooks/notifications",
  "documentNotification": {
    "documentFailed": {
      "documentId": "7c6d9a9d-c49b-45b7-94e8-4f4b8f31b521",
      "documentType": "ACCOUNT_CONFIRMATION_LETTER",
      "parameters": {
        "accountId": "4d2f3a8c7b1e4f5ea92d3b6c8f11aa29"
      },
      "error": {
        "title": "Document generation failed",
        "contexts": [
          {
            "code": "10199",
            "message": "Account 9017721143 is closed and cannot generate account confirmation letter"
          }
        ]
      }
    }
  }
}