Request Debit for CAD
Use this endpoint to initiate a CAD Interac collection request from a customer's account.
This is a server-to-server request. The merchant's backend sends the request directly to LedgerBlock.
Method: POST
Endpoint:
{{base_url}}/api/v1/collection/subwalletAuthentication
API Key Bearer Token
Include the API key as a Bearer token in the Authorization header.
Headers
| Header | Value |
|---|---|
| Authorization | Bearer <api-key> |
| x-merchant-ref | <merchant-ref> |
| Content-Type | application/json |
Request Body
{
"user_ref": "USER-REF-001",
"txn_merchant_ref": "TXN-REF-001",
"amount": 20.00,
"currency": "CAD",
"payment_method": "CAD_INTERAC",
"pay_meta_data": {
"customer_email": "[email protected]",
"customer_name": "Test User"
},
"notification_url": "https://example.com/webhook"
}Request Fields
| Field | Required | Description |
|---|---|---|
user_ref | Yes | Reference of the user making the payment |
txn_merchant_ref | Yes | Unique merchant reference for the transaction |
amount | Yes | Amount to be collected |
currency | Yes | Collection currency. For this flow, use CAD |
payment_method | Yes | Payment method. For CAD Interac collection, use CAD_INTERAC |
pay_meta_data.customer_email | Yes | Customer's email address |
pay_meta_data.customer_name | Yes | Customer's name |
notification_url | Yes | URL where transaction status notifications will be sent |
Response
{
"status": "success",
"message": "Interac money request sent - awaiting payer approval",
"data": {
"payment_ref": "PAYMENT-REF-001",
"txn_merchant_ref": "TXN-REF-001",
"amount": 20,
"currency": "CAD",
"pay_data": {
"expires_at": "2026-09-06T09:54:36+00:00",
"message": "Interac money request sent successfully.",
"reference": "INTERAC-REF-001",
"transaction_id": "TRANSACTION-REF-001"
}
}
}Response Fields
| Field | Description |
|---|---|
status | Status of the request |
message | Message indicating that the Interac request was sent and is awaiting payer approval |
data.payment_ref | LedgerBlock payment reference |
data.txn_merchant_ref | Merchant reference for the transaction |
data.amount | Amount requested for collection |
data.currency | Collection currency |
data.pay_data.expires_at | Expiration time for the Interac payment request |
data.pay_data.message | Interac payment request message |
data.pay_data.reference | Interac payment reference |
data.pay_data.transaction_id | Interac transaction identifier |
Collection Flow
Merchant Backend → LedgerBlock → Interac Money Request → Payer Approval → Collection Completed
The initial response confirms that the Interac money request has been sent. The transaction remains awaiting payer approval until the customer approves the request.
Updated 2 months ago
Did this page help you?
