Skip to content

BPN-3561 Add collection.credited event to docs #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kingsleyndiewo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

BPN-3561 Add collection.credited event to docs #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion source/includes/_collecting_funds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ See the [Collections](#collections) documentation for more information on how to

**Related Events**

The "collection.received" event is triggered whenever you receive funds from a user. You can configure a web link to receive notifications whenever this event occurs. This will allow you to respond automatically whenever you receive funds. See our [Webhooks API](#webhooks) documentation for more information.
The "collection.received" event is triggered whenever a collection is matched to your organization. You can configure a web link to receive notifications whenever this event occurs. This will allow you to respond automatically whenever you receive a collection. See our [Webhooks API](#webhooks) documentation for more information.

The "collection.credited" event is triggered whenever a matched collection is actually credited to a wallet. You can configure a web link to receive notifications whenever this event occurs. This will allow you to respond automatically whenever you receive funds. See our [Webhooks API](#webhooks) documentation for more information.

The "collectionrequest.status.changed" event is triggered whenever the status of your collection request changes, for example if a collection is received in response to your collection request, or if the collection request fails or expires. You can configure a web link to receive notifications whenever this event occurs. This will allow you to respond automatically to updates made to your collection request. See our [Webhooks API](#webhooks) documentation for more information.
1 change: 1 addition & 0 deletions source/includes/methods/_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Event | Description | Object returned in data
--------- | -------- | ----------------------
payment.status.changed | Triggered any time a payment changes state. See the "Payments" section for possible state values. | Payment object
collection.received | Triggered any time a collection (an incoming payment) is received from a customer | Collection object
collection.credited | Triggered any time a collection (an incoming payment) is actually credited to a wallet | Collection object
contact.created | Triggered any time a contact is created in your account | Contact object
collectionrequest.status.changed | Triggered any time a collection request status changes. See the "Collection Requests" section for possible status values. | CollectionRequest object

Expand Down