Confirm CAD Payout

Confirms an initiated CAD payout using the authentication token and the user's wallet PIN. Once confirmed, the payout moves to processing.

Request

POST {{base_url}}/api/v1/payout/wallet-cad/confirm

Authentication

LedgerBlock uses Bearer Token authentication. Include your API key in the Authorization header.

Parameter	Value	Type
Authorization	`{{api_key}}`	Bearer Token

Headers

Header	Required	Description	Example
`Content-Type`	Yes	Specifies that the request body is JSON.	`application/json`
`x-merchant-ref`	Yes	Unique reference identifying the merchant.	`{{vault:x-merchant-ref}}`

Request Body

Parameter	Required	Description	Example
`user_ref`	Yes	Unique reference identifying the user who initiated the payout.	`{{merchant_user_ref}}`
`auth_token`	Yes	Authentication token returned when the payout was initiated.	`{{auth_token}}`
`wallet_pin`	Yes	User's wallet PIN used to authorize the payout.	`123456`

Example Request

{
  "user_ref": "{{merchant_user_ref}}",
  "auth_token": "{{auth_token}}",
  "wallet_pin": "123456"
}

Example Response

{
  "status": "success",
  "message": "Payout confirmed. Processing",
  "data": {
    "payment_ref": "dummy-payment-ref-001",
    "txn_merchant_ref": "DUMMY_CAD_PAYOUT_001",
    "currency": "CAD",
    "payment_status": "PENDING",
    "auth_token": "",
    "expires_in_seconds": 0
  }
}

Response

Field	Description
`status`	Indicates whether the confirmation request was successful.
`message`	Provides the result of the payout confirmation.
`data.payment_ref`	Unique reference assigned to the payout by LedgerBlock.
`data.txn_merchant_ref`	Merchant-generated reference associated with the payout.
`data.currency`	Currency used for the payout. `CAD` indicates Canadian dollars.
`data.payment_status`	Current status of the payout. `PENDING` indicates that processing is underway.
`data.auth_token`	Authentication token returned in the response. Empty when no further confirmation token is provided.
`data.expires_in_seconds`	Token validity duration in seconds. `0` indicates that no active confirmation token is provided.