Confirm Request Debit Payout

The Confirm Request Debit Payout endpoint confirms a previously initialized debit request using the authorization token and wallet PIN. Once confirmed, the payout enters processing.

Request

POST {{base_url}}/api/v1/user/wallet/debit/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 debit request.	`DUMMY_USER_REF_001`
`auth_token`	Yes	Authorization token returned when the debit request was initialized.	`{{auth_token}}`
`wallet_pin`	Yes	PIN for the source wallet used to authorize the debit.	`123456`

Example Request

{
  "user_ref": "DUMMY_USER_REF_001",
  "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_LBREF_000001",
    "currency": "NGN",
    "payment_status": "PENDING",
    "auth_token": "",
    "expires_in_seconds": 0
  }
}

Response Parameters

Field	Description
`status`	Indicates whether the confirmation request was successful.
`message`	Provides the result of the confirmation request.
`data.payment_ref`	Unique reference assigned to the payout.
`data.txn_merchant_ref`	Merchant reference associated with the transaction.
`data.currency`	Currency of the payout.
`data.payment_status`	Current payout status. `PENDING` indicates that processing is ongoing.
`data.auth_token`	Empty after confirmation because the authorization token is no longer needed.
`data.expires_in_seconds`	Remaining authorization-token validity in seconds. `0` indicates that the confirmation token has expired or is no longer active.