Collections overview
Understanding collections and how to attach customers to transactions
Collections can be triggered by external payment flows such as Interac, virtual bank accounts, and API card collections.
After receiving a confirmed collection webhook, you can attach a verified customer to the collection when the collection type supports post-creation customer assignment.
For CAD collections, you must have added an Interac email (e.g. support@blaaiz.com) via the Blaaiz dashboard. Without this, funds will not reflect in your wallet.
Attach a customer to the collection
Once a collection transaction is confirmed, you'll need to associate it with a customer.
- Endpoint:
/collection/attach-customer - Request: Provide the
customer_idandtransaction_idto associate a customer with the collection transaction. - Customer requirement: The customer must belong to your business and must be
VERIFIED. Bothtype=individual(verified through KYC) andtype=business(verified through the KYB flow) are accepted. - Purpose: This links the collection to a customer for attribution and downstream processing.
API card collections must be created with customer_id up front. They cannot be updated later with /collection/attach-customer.
Webhooks
Collection events are sent to your configured collection_url.
- Successful collection notifications let you reconcile inbound payments.
- Customer KYC events such as
customer.created,customer.verified, andcustomer.rejectedalso go tocollection_url. - Virtual account events are also delivered to
collection_url.
See Webhook events and payloads for the event list and Register webhook URLs for configuration.
Related endpoints
- Initiate collection - initiate API card collections.
- Attach customer to collection - associate a supported collection with a verified customer.
- Accept Interac money request - accept an incoming Interac transfer into your wallet.
- Initiate Interac money request - request CAD from a payer's email; funds settle when they approve.