Skip to main content
Ready-to-LaunchCustom Builds
Start Building Now

Events

receivedPayment.created​

Occurs when a Received Payment is created.

Example receivedPayment.created payload:
{
  "data": [
    {
      "id": "1337",
      "type": "receivedPayment.created",
      "attributes": {
        "createdAt": "2021-06-06T09:09:15.247Z",
        "status": "Pending",
        "type": "Ach",
        "amount": 500000,
        "direction": "Credit",
        "completionDate": "2020-07-30",
        "companyName": "UBER LTD",
        "counterpartyRoutingNumber": "051402372",
        "description": "paycheck",
        "traceNumber": "123456789123456",
        "secCode": "PPD",
        "returnCutoffTime": "2024-08-27T18:00:00.000Z",
        "canBeReprocessed": "false",
        "addenda": "",
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "receivedPayment": {
          "data": {
            "id": "122",
            "type": "receivedPayment"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

receivedPayment.pending​

Occurs when a Received Payment is pending due to future settlement date.

Example receivedPayment.pending payload:
{
  "data": [
    {
      "id": "1337",
      "type": "receivedPayment.pending",
      "attributes": {
        "createdAt": "2021-06-06T07:21:39.509Z",
        "previousStatus": "PendingReview",
        "wasAdvanced": false,
        "isAdvanceable": true,
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "receivedPayment": {
          "data": {
            "id": "122",
            "type": "receivedPayment"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

receivedPayment.pendingReview​

Occurs when a Received Payment is pending review.

Example receivedPayment.pendingReview payload:
{
  "data": [
    {
      "id": "1337",
      "type": "receivedPayment.pendingReview",
      "attributes": {
        "createdAt": "2021-06-06T09:09:15.247Z",
        "status": "PendingReview",
        "type": "Ach",
        "amount": 500000,
        "completionDate": "2020-07-30",
        "companyName": "UBER LTD",
        "counterpartyRoutingNumber": "051402372",
        "description": "paycheck",
        "traceNumber": "123456789123456",
        "secCode": "PPD",
        "addenda": "",
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "receivedPayment": {
          "data": {
            "id": "122",
            "type": "receivedPayment"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

receivedPayment.advanced​

Occurs when a Received Payment is advanced.

Example receivedPayment.advanced payload:
{
  "data": [
    {
      "id": "411",
      "type": "receivedPayment.advanced",
      "attributes": {
        "createdAt": "2021-06-06T07:21:39.509Z",
        "previousStatus": "Pending",
        "wasAdvanced": true,
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "receivedPayment": {
          "data": {
            "id": "1337",
            "type": "receivedPayment"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

receivedPayment.completed​

Occurs when a Received Payment is completed.

Example receivedPayment.completed payload:
{
  "data": [
    {
      "id": "411",
      "type": "receivedPayment.completed",
      "attributes": {
        "createdAt": "2021-06-06T07:21:39.509Z",
        "previousStatus": "Advanced",
        "wasAdvanced": true,
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "receivedPayment": {
          "data": {
            "id": "1337",
            "type": "receivedPayment"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

receivedPayment.markedForReturn​

Occurs when a Received Payment is marked for return. The payment may still be reprocessed if canBeReprocessed is true.

Example receivedPayment.markedForReturn payload:
{
  "data": [
    {
      "id": "1337",
      "type": "receivedPayment.markedForReturn",
      "attributes": {
        "createdAt": "2021-06-06T09:09:15.247Z",
        "status": "MarkedForReturn",
        "type": "Ach",
        "amount": 500000,
        "completionDate": "2020-07-30",
        "companyName": "UBER LTD",
        "counterpartyRoutingNumber": "051402372",
        "description": "paycheck",
        "traceNumber": "123456789123456",
        "secCode": "PPD",
        "returnCutoffTime": "2024-08-27T18:00:00.000Z",
        "canBeReprocessed": "true",
        "addenda": "",
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "receivedPayment": {
          "data": {
            "id": "122",
            "type": "receivedPayment"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

receivedPayment.returned​

Occurs when a Received Payment is returned. See ACH Return Reasons for possible return reasons.

Example receivedPayment.returned payload:
{
  "data": [
    {
      "id": "1337",
      "type": "receivedPayment.returned",
      "attributes": {
        "createdAt": "2021-06-06T09:09:15.247Z",
        "status": "Returned",
        "type": "Ach",
        "amount": 500000,
        "completionDate": "2020-07-30",
        "companyName": "UBER LTD",
        "counterpartyRoutingNumber": "051402372",
        "description": "paycheck",
        "traceNumber": "123456789123456",
        "secCode": "PPD",
        "addenda": "",
        "returnReason": "InsufficientFunds",
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "receivedPayment": {
          "data": {
            "id": "122",
            "type": "receivedPayment"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

declinedIncomingPayment.created​

Occurs when a Declined Incoming Payment is created. This happens when an incoming ACH payment is declined before a received payment is created.

Example declinedIncomingPayment.created payload:
{
  "data": [
    {
      "id": "295",
      "type": "declinedIncomingPayment.created",
      "attributes": {
        "createdAt": "2021-01-02T13:38:28.223Z",
        "amount": 1000,
        "direction": "Debit",
        "reason": "NoAccount",
        "paymentType": "AchPayment"
      },
      "relationships": {
        "account": {
          "data": {
            "id": "10009",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10002",
            "type": "customer"
          }
        }
      }
    }
  ]
}

transaction.created​

Occurs when a Received ACH Transaction is created. This happens when a received ACH payment is completed or advanced.

Example transaction.created payload:
{
  "data": [
    {
      "id": "34",
      "type": "transaction.created",
      "attributes": {
        "summary": "ACH payment received from UBER LTD",
        "direction": "Credit",
        "amount": 500000,
        "balance": 689305,
        "createdAt": "2020-07-30T09:17:21.593Z",
        "tags": {
          "tag": "value"
        }
      },
      "relationships": {
        "transaction": {
          "data": {
            "type": "receivedAchTransaction",
            "id": "10001"
          }
        },
        "account": {
          "data": {
            "id": "1000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1",
            "type": "customer"
          }
        }
      }
    }
  ]
}