Events
Unit uses Events
to record important changes happening under your org.
Once an event is created, it will be delivered to your application via a webhook call.
Our event types follow a specific structure: resource.event
.
Each event includes an id
field, which uniquely identifies the event instance,
and a type
field that identifies the type of the event instance.
Each event type includes a different set of attributes and relationships, relevant to that specific event.
Event attributes may contain a set of custom tags inherited from a related resource request.
#
account.createdOccurs when an Account is created successfully.
{ "data": [ { "id": "269", "type": "account.created", "attributes": { "createdAt": "2021-04-13T07:40:43.813Z", "tags": { "tag": "value" } }, "relationships": { "account": { "data": { "id": "10004", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
account.closedOccurs when an Account is closed.
{ "data": [ { "id": "269", "type": "account.closed", "attributes": { "createdAt": "2021-04-13T07:40:43.813Z", "closeReason": "ByCustomer", "tags": { "tag": "value" } }, "relationships": { "account": { "data": { "id": "10004", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
account.reopenedOccurs when a closed Account is reopened.
{ "data": [ { "id": "2724", "type": "account.reopened", "attributes": { "createdAt": "2021-12-13T07:40:43.813Z" }, "relationships": { "account": { "data": { "id": "10004", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
account.frozenOccurs when an Account is frozen.
{ "data": [ { "id": "2354", "type": "account.frozen", "attributes": { "createdAt": "2021-11-08T07:43:13.813Z", "freezeReason": "Fraud", "tags": { "tag": "value" } }, "relationships": { "account": { "data": { "id": "10004", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
account.unfrozenOccurs when a frozen Account is unfrozen.
{ "data": [ { "id": "2355", "type": "account.unfrozen", "attributes": { "createdAt": "2021-12-08T07:43:13.813Z" }, "relationships": { "account": { "data": { "id": "10004", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
account.updatedOccurs when an Account is updated. The list of changes is provided in the changes
attribute.
{ "data": [ { "id": "269", "type": "account.updated", "attributes": { "createdAt": "2023-04-13T07:40:43.813Z", "changes": { "depositProduct": { "previous": "934", "current": "120009" } } }, "relationships": { "account": { "data": { "id": "10004", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
application.createdOccurs when an Application is created.
{ "data": [ { "id": "28", "type": "application.created", "attributes": { "createdAt": "2020-07-29T12:53:05.882Z", "tags": { "tag": "value" } }, "relationships": { "application": { "data": { "id": "52", "type": "individualApplication" } } } } ]}
#
application.deniedOccurs when an Application is denied.
{ "data": [ { "id": "28", "type": "application.denied", "attributes": { "createdAt": "2020-07-29T12:53:05.882Z", "tags": { "tag": "value" } }, "relationships": { "application": { "data": { "id": "52", "type": "individualApplication" } } } } ]}
#
application.canceledOccurs when an Application is canceled.
{ "data": [ { "id": "28", "type": "application.canceled", "attributes": { "createdAt": "2020-07-29T12:53:05.882Z", "tags": { "tag": "value" } }, "relationships": { "application": { "data": { "id": "52", "type": "individualApplication" } } } } ]}
#
application.pendingReviewOccurs when an Application is in pendingReview state.
{ "data": [ { "id": "28", "type": "application.pendingReview", "attributes": { "createdAt": "2020-07-29T12:53:05.882Z", "tags": { "tag": "value" } }, "relationships": { "application": { "data": { "id": "52", "type": "individualApplication" } } } } ]}
#
application.awaitingDocumentsOccurs when additional Application Documents are required to approve an Application.
{ "data": [ { "id": "3000", "type": "application.awaitingDocuments", "attributes": { "createdAt": "2020-07-29T12:53:05.882Z", "tags": { "tag": "value" } }, "relationships": { "application": { "data": { "id": "87", "type": "individualApplication" } } } } ]}
#
authorization.createdOccurs when an Authorization is created.
{ "data": [ { "id": "83", "type": "authorization.created", "attributes": { "createdAt": "2021-02-21T07:31:18.692Z", "amount": 1500, "available": 2000, "cardLast4Digits": "0019", "merchant": { "name": "Apple Inc.", "type": "1000", "id": "311204598883" }, "recurring": false, "tags": { "tag": "value" } }, "relationships": { "authorization": { "data": { "id": "98", "type": "authorization" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "1", "type": "card" } } } } ]}
#
authorization.canceledOccurs when an Authorization is canceled.
{ "data": [ { "id": "83", "type": "authorization.canceled", "attributes": { "createdAt": "2021-02-21T07:31:18.692Z", "amount": 1500, "available": 2000, "cardLast4Digits": "0019", "recurring": false, "tags": { "tag": "value" } }, "relationships": { "authorization": { "data": { "id": "98", "type": "authorization" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "1", "type": "card" } } } } ]}
#
authorization.amountChangedOccurs when an Authorization amount is changed. This event will be followed by an authorizationRequest.pending event.
{ "data": [ { "id": "83", "type": "authorization.amountChanged", "attributes": { "createdAt": "2021-02-21T07:31:18.692Z", "oldAmount": 1700, "newAmount": 2000, "available": 2000, "tags": { "tag": "value" } }, "relationships": { "authorization": { "data": { "id": "98", "type": "authorization" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "1", "type": "card" } } } } ]}
#
authorization.declinedOccurs when an Authorization is declined.
{ "data": [ { "id": "83", "type": "authorization.declined", "attributes": { "createdAt": "2021-02-21T07:31:18.692Z", "amount": 1500, "available": 1400, "cardLast4Digits": "0019", "merchant": { "name": "Apple Inc.", "type": "1000", "id": "311204598883" }, "recurring": false, "reason": "InsufficientFunds", "tags": { "tag": "value" } }, "relationships": { "authorization": { "data": { "id": "98", "type": "authorization" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "1", "type": "card" } } } } ]}
#
authorization.updatedOccurs when an Authorization is updated.
{ "data": [ { "id": "83", "type": "authorization.updated", "attributes": { "createdAt": "2021-02-21T07:31:18.692Z", "tags": { "tag": "value" } }, "relationships": { "authorization": { "data": { "id": "98", "type": "authorization" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "1", "type": "card" } } } } ]}
#
authorizationRequest.approvedOccurs when an AuthorizationRequest is approved. See Programmatic authorization of card use
{ "data": [ { "id": "412", "type": "authorizationRequest.approved", "attributes": { "createdAt": "2021-06-24T08:10:08.081Z", "amount": 2000, "available": 2500, "status": "Approved", "approvedAmount": 2000, "partialApprovalAllowed": false, "merchant": { "name": "Merchant name", "type": "6012", "id": "311204598883" }, "recurring": false, "tags": { "tag": "value" } }, "relationships": { "authorizationRequest": { "data": { "id": "6", "type": "purchaseAuthorizationRequest" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "7", "type": "card" } } } } ]}
#
authorizationRequest.declinedOccurs when an AuthorizationRequest is declined. See Programmatic authorization of card use
{ "data": [ { "id": "412", "type": "authorizationRequest.declined", "attributes": { "createdAt": "2021-06-24T08:10:08.081Z", "amount": 2000, "available": 1900, "status": "Declined", "declineReason": "InsufficientFunds", "partialApprovalAllowed": false, "merchant": { "name": "Merchant name", "type": "6012", "id": "311204598883" }, "recurring": false, "tags": { "tag": "value" } }, "relationships": { "authorizationRequest": { "data": { "id": "6", "type": "purchaseAuthorizationRequest" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "7", "type": "card" } } } } ]}
#
authorizationRequest.pending (Purchase)Occurs when a Purchase related AuthorizationRequest is pending approval. See Programmatic authorization of card use
{ "data": [ { "id": "412", "type": "authorizationRequest.pending", "attributes": { "createdAt": "2021-06-24T08:10:08.081Z", "amount": 2000, "available": 150000, "status": "Pending", "partialApprovalAllowed": false, "merchant": { "name": "Merchant name", "type": "6012", "id": "311204598883" }, "recurring": false, "ecommerce": true, "cardPresent": false, "direction": "Debit", "mustBeApproved": false, "tags": { "tag": "value" } }, "relationships": { "authorizationRequest": { "data": { "id": "6", "type": "purchaseAuthorizationRequest" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "7", "type": "card" } } } } ]}
#
authorizationRequest.pending (CardTransaction)Occurs when a CardTransaction related AuthorizationRequest is pending approval. See Programmatic authorization of card use
Note that the type of the authorization request under relationships
here is capitalised (CardTransactionAuthorizationRequest
), unlike the corresponding resource.
{ "data": [ { "id": "415", "type": "authorizationRequest.pending", "attributes": { "createdAt": "2021-06-24T08:10:08.081Z", "amount": 2000, "available": 150000, "status": "Pending", "direction": "Debit", "partialApprovalAllowed": false, "merchant": { "name": "Merchant name", "type": "6012", "id": "311204598883" }, "recurring": false, "mustBeApproved": false, "tags": { "tag": "value" } }, "relationships": { "authorizationRequest": { "data": { "id": "8", "type": "CardTransactionAuthorizationRequest" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "7", "type": "card" } } } } ]}
#
authorizationRequest.pending (IIAS)Occurs when an IIAS related AuthorizationRequest is pending approval. See Programmatic authorization of card use
{ "data": [ { "id": "412", "type": "authorizationRequest.pending", "attributes": { "createdAt": "2021-06-24T08:10:08.081Z", "amount": 2000, "available": 150000, "status": "Pending", "partialApprovalAllowed": true, "merchant": { "name": "Merchant name", "type": "6012" }, "recurring": false, "ecommerce": true, "cardPresent": false, "healthCareAmounts": { "transitAmount": 0, "prescriptionRXAmount": 0, "visionOpticalAmount": 2000, "clinicOtherQualifiedMedicalAmount": 0, "dentalAmount": 0, "totalHealthcareAmount": 2000 }, "direction": "Debit", "mustBeApproved": false, "tags": { "tag": "value" } }, "relationships": { "authorizationRequest": { "data": { "id": "6", "type": "purchaseAuthorizationRequest" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "card": { "data": { "id": "7", "type": "card" } } } } ]}
#
bulkPayments.failedOccurs when a Payment in bulk failed.
{ "data": [ { "id": "1", "type": "bulkPayments.failed", "attributes": { "createdAt": "2021-01-02T13:38:28.223Z", "tags": { "tag": "value" }, "index": "2", "error": "{\"title\":\"User is not allowed to create a payment\",\"status\":\"403\"}", "idempotencyKey": "1 2" }, "relationships": { "bulkPayments": { "data": { "id": "1", "type": "bulkPayments" } } } } ]}
#
bulkPayments.finishedOccurs when a Payments bulk is finished.
{ "data": [ { "id": "1", "type": "bulkPayments.finished", "attributes": { "createdAt": "2021-01-02T13:38:28.223Z" }, "relationships": { "bulkPayments": { "data": { "id": "1", "type": "bulkPayments" } } } } ]}
#
card.createdOccurs when a Card is created successfully.
{ "data": [ { "id": "73", "type": "card.created", "attributes": { "createdAt": "2021-02-15T09:23:47.778Z", "tags": { "tag": "value" } }, "relationships": { "card": { "data": { "id": "6", "type": "individualDebitCard" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
card.activatedOccurs when a Card is activated for the first time.
{ "data": [ { "id": "73", "type": "card.activated", "attributes": { "createdAt": "2021-02-15T09:23:47.778Z", "tags": { "tag": "value" } }, "relationships": { "card": { "data": { "id": "6", "type": "individualDebitCard" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
card.statusChangedOccurs when a Card status changes, excluding first time card activation (see card.activated).
{ "data": [ { "id": "74", "type": "card.statusChanged", "attributes": { "createdAt": "2021-02-22T09:23:47.778Z", "newStatus": "Lost", "previousStatus": "Active", "tags": { "tag": "value" } }, "relationships": { "card": { "data": { "id": "6", "type": "individualDebitCard" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkDeposit.createdOccurs when a Check Deposit is created.
{ "data": [ { "id": "382", "type": "checkDeposit.created", "attributes": { "createdAt": "2021-06-06T09:09:15.247Z", "status": "AwaitingImages", "tags": { "tag": "value" } }, "relationships": { "checkDeposit": { "data": { "id": "122", "type": "checkDeposit" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkDeposit.pendingReviewOccurs when a Check Deposit is pending review.
{ "data": [ { "id": "376", "type": "checkDeposit.pendingReview", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "AwaitingBackImage", "tags": { "tag": "value" } }, "relationships": { "checkDeposit": { "data": { "id": "122", "type": "checkDeposit" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkDeposit.pendingOccurs when a Check Deposit is pending processing.
{ "data": [ { "id": "376", "type": "checkDeposit.pending", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "PendingReview", "tags": { "tag": "value" } }, "relationships": { "checkDeposit": { "data": { "id": "122", "type": "checkDeposit" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkDeposit.rejectedOccurs when a Check Deposit was rejected.
{ "data": [ { "id": "411", "type": "checkDeposit.rejected", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "Pending", "reason": "Cannot read check. Please retake photo. Have steady hands, good lighting, and four check corners visible.", "tags": { "tag": "value" } }, "relationships": { "checkDeposit": { "data": { "id": "122", "type": "checkDeposit" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkDeposit.clearingOccurs when a Check Deposit is in the process of being cleared.
{ "data": [ { "id": "376", "type": "checkDeposit.clearing", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "Pending", "tags": { "tag": "value" } }, "relationships": { "checkDeposit": { "data": { "id": "122", "type": "checkDeposit" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkDeposit.sentOccurs when a Check Deposit was processed.
{ "data": [ { "id": "376", "type": "checkDeposit.sent", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "Clearing", "tags": { "tag": "value" } }, "relationships": { "checkDeposit": { "data": { "id": "122", "type": "checkDeposit" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkDeposit.returnedOccurs when a Check Deposit was returned.
{ "data": [ { "id": "376", "type": "checkDeposit.returned", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "Sent", "tags": { "tag": "value" } }, "relationships": { "checkDeposit": { "data": { "id": "122", "type": "checkDeposit" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.createdOccurs when a Check Payment is created.
{ "data": [ { "id": "382", "type": "checkPayment.created", "attributes": { "createdAt": "2021-06-06T09:09:15.247Z", "status": "Processed", "additionalVerificationStatus": true }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" }, "transaction": { "data": { "id": "10001", "type": "transaction" } } } } } ]}
#
checkPayment.markedForReturnOccurs when a Check Payment was marked for return after being pending review status.
{ "data": [ { "id": "376", "type": "checkPayment.markedForReturn", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "PendingReview" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.processedOccurs when a Check Payment was processed after being in status pending review.
{ "data": [ { "id": "376", "type": "checkPayment.processed", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "PendingReview", "additionalVerificationStatus": true }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } }, "transaction": { "data": { "id": "10001", "type": "transaction" } } } } ]}
#
checkPayment.returnedOccurs when a Check Payment was returned after being in marked for return status.
{ "data": [ { "id": "376", "type": "checkPayment.returned", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "MarkedForReturn" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.pendingOccurs when a Check Payment is created successfully and changes to pending
status. If the counterparty's address has been modified due to a National Change of Address, this will be indicated by the counterpartyMoved
flag.
{ "data": [ { "id": "376", "type": "checkPayment.pending", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "status": "Pending", "previousStatus": "New", "counterpartyMoved": true }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.inProductionOccurs when a Check Payment was inProduction after being in status pending.
{ "data": [ { "id": "376", "type": "checkPayment.inProduction", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "Pending" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.inDeliveryOccurs when a Check Payment was inDelivery after being in status inProduction.
{ "data": [ { "id": "376", "type": "checkPayment.inDelivery", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "InProduction", "status": "InDelivery", "deliveryStatus": "Mailed", "trackedAt": "2021-06-06T07:21:39.509Z" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.deliveredOccurs when a Check Payment was delivered after being in status inDelivery.
{ "data": [ { "id": "376", "type": "checkPayment.delivered", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "status": "Delivered", "previousStatus": "InDelivery" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.returnToSenderFired when a Check Payment is returned to sender. This can occur after the check is delivered. No check payment events are expected after a return to sender is triggered.
{ "data": [ { "id": "376", "type": "checkPayment.returnToSender", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "status": "Delivered", "previousStatus": "InDelivery" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.canceledOccurs when a Check Payment was canceled after being in status pending.
{ "data": [ { "id": "376", "type": "checkPayment.canceled", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousStatus": "Pending" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.deliveryStatusChangedOccurs when a Check Payment has a status update.
{ "data": [ { "id": "376", "type": "checkPayment.deliveryStatusChanged", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "previousDeliveryStatus": "InLocalArea", "NewDeliveryStatus": "Rerouted", "trackedAt": "2021-06-06T09:21:39.509Z", "postalCode": "11375" }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.additionalVerificationRequiredOccurs when a Check Payment is created and requires an additional verification approval.
{ "data": [ { "id": "382", "type": "checkPayment.additionalVerificationRequired", "attributes": { "createdAt": "2021-06-06T09:09:15.247Z", "status": "Processed", "amount": 30000000 }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
checkPayment.additionalVerificationApprovedOccurs when a Check Payment that required an additional verification is approved using additional verification approval.
{ "data": [ { "id": "382", "type": "checkPayment.additionalVerificationApproved", "attributes": { "createdAt": "2021-06-06T09:09:15.247Z", "status": "Processed", "amount": 30000000 }, "relationships": { "checkPayment": { "data": { "id": "122", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
stopPayment.createdOccurs when a Stop Payment is created.
{ "data": [ { "id": "382", "type": "stopPayment.created", "attributes": { "createdAt": "2021-06-06T09:09:15.247Z" }, "relationships": { "stopPayment": { "data": { "id": "122", "type": "stopPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
stopPayment.paymentStoppedOccurs when a Stop Payment has stopped an incoming check payment.
{ "data": [ { "id": "376", "type": "stopPayment.paymentStopped", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "stoppedPaymentType": "checkPayment" }, "relationships": { "stopPayment": { "data": { "id": "122", "type": "stopPayment" } }, "stoppedPayment": { "data": { "id": "1243", "type": "checkPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
stopPayment.disabledOccurs when a Stop Payment was disabled.
{ "data": [ { "id": "376", "type": "stopPayment.disabled", "attributes": { "createdAt": "2021-06-06T07:21:39.509Z", "status": "Disabled", "previousStatus": "Active" }, "relationships": { "stopPayment": { "data": { "id": "122", "type": "stopPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
customer.createdOccurs when a new Customer is created.
{ "data": [ { "id": "28", "type": "customer.created", "attributes": { "createdAt": "2020-07-29T12:53:05.882Z", "tags": { "tag": "value" } }, "relationships": { "customer": { "data": { "id": "52", "type": "individualCustomer" } }, "application": { "data": { "id": "52", "type": "individualApplication" } } } } ]}
#
customer.updatedOccurs when a Customer is updated (whether by the org, or by Unit, in case the fields being updated are sensitive fields ).
{ "data": [ { "id": "9", "type": "customer.updated", "attributes": { "createdAt": "2021-11-29T17:23:08.778Z", "changes": { "phone": { "countryCode": "1", "number": "1555555577" }, "email": "richard2@piedpiper.com" } }, "relationships": { "customer": { "data": { "id": "10000", "type": "individualCustomer" } } } } ]}
#
customer.archivedOccurs when a Customer is archived.
{ "data": [ { "id": "1337", "type": "customer.archived", "attributes": { "createdAt": "2021-04-13T07:40:43.813Z", "archiveReason": "Inactive", "tags": { "tag": "value" } }, "relationships": { "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
declinedIncomingPayment.createdOccurs when a Declined Incoming Payment is created.
{ "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" } } } } ]}
#
dispute.createdOccurs when a Dispute is created.
{ "data": [ { "id": "680", "type": "dispute.created", "attributes": { "createdAt": "2022-01-01T14:08:19.040Z", "amount": 500, "description": "Disputed card transaction", "source": "DebitCard", "status": "InvestigationStarted" }, "relationships": { "dispute": { "data": { "id": "47", "type": "dispute" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } }, "transaction": { "data": { "id": "142", "type": "transaction" } } } } ]}
#
dispute.statusChangedOccurs when a Dispute status changes.
{ "data": [ { "id": "687", "type": "dispute.statusChanged", "attributes": { "createdAt": "2022-01-01T10:22:31.816Z", "previousStatus": "InvestigationStarted", "newStatus": "ResolvedWon" }, "relationships": { "dispute": { "data": { "id": "47", "type": "dispute" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } }, "transaction": { "data": { "id": "142", "type": "transaction" } } } } ]}
#
document.approvedOccurs when an Application Document is approved.
{ "data": [ { "id": "193", "type": "document.approved", "attributes": { "createdAt": "2020-11-09T09:05:49.999Z", "tags": { "tag": "value" } }, "relationships": { "document": { "data": { "id": "6", "type": "document" } }, "application": { "data": { "id": "10009", "type": "individualApplication" } } } } ]}
#
document.rejectedOccurs when an Application Document is rejected.
{ "data": [ { "id": "190", "type": "document.rejected", "attributes": { "reason": "blurry image", "reasonCode": "PoorQuality", "createdAt": "2020-11-08T18:34:38.533Z", "tags": { "tag": "value" } }, "relationships": { "document": { "data": { "id": "6", "type": "document" } }, "application": { "data": { "id": "10009", "type": "individualApplication" } } } } ]}
#
payment.createdOccurs when an ACH Payment, Book Payment or Wire Payment is successfully created with a specified status. This event does not fire for rejected payments, see payment.rejected instead.
{ "data": [ { "id": "4132", "type": "payment.created", "attributes": { "createdAt": "2021-12-27T12:12:39.133Z", "status": "Pending", "direction": "Credit", "amount": 2500, "tags": { "tag": "value" } }, "relationships": { "payment": { "data": { "id": "6", "type": "payment" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
payment.clearingOccurs when an originated Debit ACH Payment was delivered to the ACH network, but the account was not credited yet.
{ "data": [ { "id": "290", "type": "payment.clearing", "attributes": { "previousStatus": "Pending", "createdAt": "2020-11-08T18:34:38.533Z", "direction": "Credit", "amount": 2500, "available": 3000, "tags": { "tag": "value" } }, "relationships": { "payment": { "data": { "id": "6", "type": "payment" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
payment.sentOccurs when a payment was created and processed successfully.
The event covers different types of payments like ACH Payment, Book Payment, Wire Payment and Push To Card Payment.
{ "data": [ { "id": "291", "type": "payment.sent", "attributes": { "previousStatus": "Pending", "direction": "Credit", "amount": 2500, "available": 500, "createdAt": "2020-11-08T18:34:38.533Z", "tags": { "tag": "value" } }, "relationships": { "payment": { "data": { "id": "8", "type": "payment" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
payment.rejectedOccurs when a payment gets rejected. This event should include a reason
that will specify why the payment was rejected.
The event covers different types of payments like ACH Payment, Book Payment, Wire Payment and Push To Card Payment.
{ "data": [ { "id": "291", "type": "payment.rejected", "attributes": { "createdAt": "2021-12-08T18:34:38.533Z", "reason": "InsufficientFunds", "direction": "Credit", "amount": 2500, "tags": { "tag": "value" } }, "relationships": { "payment": { "data": { "id": "6", "type": "payment" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
payment.returnedOccurs when a sent ACH Payment was returned by the ACH network or the receiving bank for a specified reason.
{ "data": [ { "id": "295", "type": "payment.returned", "attributes": { "previousStatus": "Sent", "createdAt": "2021-01-02T13:38:28.223Z", "direction": "Credit", "amount": 2500, "available": 3000, "tags": { "tag": "value" } }, "relationships": { "payment": { "data": { "id": "10", "type": "payment" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
payment.canceledpayment.canceled
or payment.Canceled
. Occurs when a sent ACH Payment was canceled by the client / end-customer before being sent to the network.
{ "data": [ { "id": "295", "type": "payment.Canceled", "attributes": { "createdAt": "2021-01-02T13:38:28.223Z", "direction": "Credit", "amount": 2500, "tags": { "tag": "value" } }, "relationships": { "payment": { "data": { "id": "10", "type": "payment" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
payment.pendingReviewOccurs when a sent ACH Payment is waiting to be manually reviewed, typically due to a high level of risk associated with that payment.
{ "data": [ { "id": "295", "type": "payment.pendingReview", "attributes": { "createdAt": "2021-01-02T13:38:28.223Z", "direction": "Credit", "amount": 2500, "tags": { "tag": "value" } }, "relationships": { "payment": { "data": { "id": "10", "type": "payment" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
recurringPayment.createdOccurs when a recurring payment is created.
{ "data": [ { "id": "360", "type": "recurringPayment.created", "attributes": { "createdAt": "2022-06-25T14:27:41.093Z", "status": "Active", "amount": 200, "tags": { "test": "test" }, "nextScheduledAction": "2022-07-05" }, "relationships": { "recurringPayment": { "data": { "id": "4", "type": "recurringPayment" } }, "account": { "data": { "id": "10002", "type": "account" } }, "customer": { "data": { "id": "10004", "type": "customer" } } } } ]}
#
recurringPayment.statusChangedOccurs when a recurring payment status has been changed. See Recurring Payment Statuses.
{ "data": [ { "id": "359", "type": "recurringPayment.statusChanged", "attributes": { "createdAt": "2022-06-25T14:23:26.785Z", "previousStatus": "Completed", "status": "Active", "amount": 200, "numberOfPayments": 2, "tags": {} }, "relationships": { "recurringPayment": { "data": { "id": "2", "type": "recurringPayment" } }, "account": { "data": { "id": "10002", "type": "account" } }, "customer": { "data": { "id": "10004", "type": "customer" } } } } ]}
#
recurringPayment.failedOccurs when a payment creation from a recurring payment has failed.
{ "data": [ { "id": "100", "type": "recurringPayment.failed", "attributes": { "createdAt": "2022-06-11T11:40:58.708Z", "amount": 200, "tags": {}, "error": "{\"title\":\"User is not allowed to create a payment\",\"status\":\"403\"}" }, "relationships": { "recurringPayment": { "data": { "id": "24", "type": "recurringPayment" } }, "account": { "data": { "id": "10002", "type": "account" } } } } ]}
#
statements.createdOccurs when all Statements were created for the previous month.
{ "data": [ { "id": "241", "type": "statements.created", "attributes": { "createdAt": "2021-03-01T00:16:28.911Z", "period": "2021-02", "tags": { "tag": "value" } } } ]}
#
transaction.createdOccurs when a Transaction is created.
{ "data": [ { "id": "34", "type": "transaction.created", "attributes": { "summary": "Funding", "direction": "Debit", "amount": 2500, "available": 3000, "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" } }, "payment": { "data": { "id": "515", "type": "payment" } } } } ]}
#
transaction.updatedOccurs when a PurchaseTransaction, AtmTransaction, or CardTransaction is updated with the interchange amount, calculated at the end of each day.
{ "data": [ { "id": "33266", "type": "transaction.updated", "available": 2000, "attributes": { "createdAt": "2020-07-30T09:17:21.593Z", "interchange": 2.43 }, "relationships": { "account": { "data": { "id": "10023", "type": "account" } }, "transaction": { "data": { "type": "purchase", "id": "45123" } } } } ]}
#
receivedPayment.createdOccurs when a Received Payment is created.
{ "data": [ { "id": "1337", "type": "receivedPayment.created", "attributes": { "createdAt": "2021-06-06T09:09:15.247Z", "status": "Pending", "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.advancedOccurs when a Received Payment is advanced.
{ "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.pendingReviewOccurs when a Received Payment is pending review.
{ "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.markedForReturnOccurs when a Received Payment is marked for return.
{ "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", "addenda": "", "tags": { "tag": "value" } }, "relationships": { "receivedPayment": { "data": { "id": "122", "type": "receivedPayment" } }, "account": { "data": { "id": "10001", "type": "account" } }, "customer": { "data": { "id": "10000", "type": "customer" } } } } ]}
#
receivedPayment.completedOccurs when a Received Payment is completed.
{ "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.returnedOccurs when a Received Payment is returned.
{ "data": [ { "id": "411", "type": "receivedPayment.returned", "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" } } } } ]}
#
chargeback.createdOccurs when a Chargeback is successfully created.
{ "data": [ { "id": "1337", "type": "chargeback.created", "attributes": { "createdAt": "2021-12-27T12:12:39.133Z", "amount": 5000, "description": "chargeback for payments issued on 12/1/2022", "tags": { "tag": "value" } }, "relationships": { "chargeback": { "data": { "id": "669", "type": "chargeback" } }, "account": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } }, "counterpartyAccount": { "data": { "id": "10010", "type": "account" } }, "transaction": { "data": { "id": "10010", "type": "transaction" } } } } ]}
#
reward.sentOccurs when a Reward is successfully sent to an end customer.
{ "data": [ { "id": "9173", "type": "reward.sent", "attributes": { "createdAt": "2021-04-02T12:12:39.133Z", "tags": { "tag": "value" } }, "relationships": { "reward": { "data": { "id": "42", "type": "reward" } }, "fundingAccount": { "data": { "id": "10009", "type": "account" } }, "receivingAccount": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
reward.rejectedOccurs when a Reward creation request is rejected (typically due to account status or availability of funds).
{ "data": [ { "id": "8246", "type": "reward.rejected", "attributes": { "createdAt": "2021-04-02T12:14:39.133Z", "tags": { "tag": "value" } }, "relationships": { "reward": { "data": { "id": "42", "type": "reward" } }, "fundingAccount": { "data": { "id": "10009", "type": "account" } }, "receivingAccount": { "data": { "id": "10009", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } } ]}
#
repayment.createdOccurs when a AchRepayment or BookRepayment is successfully created.
{ "data": { "id": "219", "type": "repayment.created", "attributes": { "createdAt": "2022-11-27T18:54:03.042Z", "amount": 1550, "tags": {}, "status": "Pending" }, "relationships": { "repayment": { "data": { "id": "9", "type": "repayment" } }, "payment": { "data": { "id": "22", "type": "payment" } }, "account": { "data": { "id": "10006", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } }}
#
repayment.statusChangedOccurs when a AchRepayment or BookRepayment status changes.
{ "data": { "id": "224", "type": "repayment.statusChanged", "attributes": { "createdAt": "2022-11-27T18:55:39.945Z", "newStatus": "Sent", "previousStatus": "Pending", "amount": 1550, "tags": {} }, "relationships": { "repayment": { "data": { "id": "9", "type": "repayment" } }, "payment": { "data": { "id": "22", "type": "payment" } }, "account": { "data": { "id": "10006", "type": "account" } }, "customer": { "data": { "id": "10002", "type": "customer" } } } }}
Get by Id#
Get an event resource by id. This API is available only for events that were created within the last 90 days.
Verb | GET |
Url | https://api.s.unit.sh/events/{id} |
Required Scope | events |
Timeout (Seconds) | 5 |
#
ResponseResponse is a JSON:API document.
#
200 OKField | Type | Description |
---|---|---|
data | Event | The requested resource after the operation was completed. |
curl -X GET 'https://api.s.unit.sh/events/10' \-H "Authorization: Bearer ${TOKEN}"
List#
List event resources, going back up to 90 days. Paging can be applied.
Verb | GET |
Url | https://api.s.unit.sh/events |
Required Scope | events |
Timeout (Seconds) | 5 |
#
Query ParametersName | Type | Default | Description |
---|---|---|---|
page[limit] | integer | 100 | Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination. |
page[offset] | integer | 0 | Optional. Number of resources to skip. See Pagination. |
filter[type][] | string | (empty) | Optional. Filter Events by Event type. |
filter[since] | RFC3339 Date string | (empty) | Optional. Filters the events that occurred after the specified date. e.g. 2022-01-13T16:01:19.346Z |
filter[until] | RFC3339 Date string | (empty) | Optional. Filters the events that occurred before the specified date. e.g. 2022-01-15T20:06:23.486Z |
curl -X GET 'https://api.s.unit.sh/events?page[limit]=20&page[offset]=10&filter[since]=2022-01-13T16:01:19.346Z`&filter[until]=2022-01-15T20:06:23.486Z' \-H "Authorization: Bearer ${TOKEN}"
#
ResponseResponse is a JSON:API document.
#
200 OKField | Type | Description |
---|---|---|
data | Array of Event | Array of event resources. |
{ "data": [ { "id": "231", "type": "customer.created", "attributes": { "createdAt": "2021-03-15T12:20:39.216Z" }, "relationships": { "customer": { "data": { "id": "10004", "type": "businessCustomer" } } } }, { "id": "230", "type": "transaction.created", "attributes": { "createdAt": "2021-03-15T07:49:09.089Z", "amount": 10000, "direction": "Credit", "summary": "Wire to Jane Smith" }, "relationships": { "account": { "data": { "id": "10005", "type": "account" } }, "transaction": { "data": { "id": "189", "type": "wireTransaction" } }, "customer": { "data": { "id": "10000", "type": "individualCustomer" } } } } ]}
Fire Event#
Resend a previously published webhook event. This API is available only for events that were created within the last 90 days.
Verb | POST |
Url | https://api.s.unit.sh/events/{eventId} |
Required Scope | events-write |
Timeout (Seconds) | 5 |
curl -X POST 'https://api.s.unit.sh/events/78'-H 'Content-Type: application/vnd.api+json'-H 'Authorization: Bearer ${TOKEN}'--data-raw '{}'