Retry PayOut

Retries a failed payout transaction within a bulk payout batch.

This endpoint allows a merchant to retry an individual payout by providing the batch_reference and the specific upload_id associated with the failed payout.

Request

Method: POST

Endpoint:

{{base_url}}/api/v1/payout/wallet-bank/retry

Authentication & Headers

Header	Type	Required	Description
`Authorization`	String	Yes	`Bearer ${auth_secret_1d9l}` — your activated authentication secret.
`x-merchant-ref`	String	Yes	Your unique merchant reference.
`Content-Type`	String	Yes	Must be set to `application/json`.

Request Body

{
  "batch_reference": "LBREF-2CC2032A-7CB2-4FAF-974A-D9FD1541FB35-003C6",
  "upload_id": "UPD-21CAA018-4EB9-4DBF-9579-84306CF0E454-00AHJ",
  "wallet_pin": ""
}

Request Fields

Field	Type	Required	Description
`batch_reference`	String	Yes	Unique reference identifying the bulk payout batch.
`upload_id`	String	Yes	Unique identifier of the specific payout transaction to be retried.
`wallet_pin`	String	Yes	Wallet PIN used to authorize the retry.

Example Request

curl --location -g '{{base_url}}/api/v1/payout/wallet-bank/retry' \
--header 'Content-Type: application/json' \
--header 'x-merchant-ref: MREFA7B012B203854910AA20F9EA8A2BA7D400B0M' \
--data '{
  "batch_reference": "LBREF-2CC2032A-7CB2-4FAF-974A-D9FD1541FB35-003C6",
  "upload_id": "UPD-21CAA018-4EB9-4DBF-9579-84306CF0E454-00AHJ",
  "wallet_pin": ""
}'

Retry Flow

The retry operation is used when an individual payout within a completed bulk payout batch has failed.

Get Bulk Payout → Identify Failed Payout → Obtain upload_id → Retry Payout → Get Bulk Payout

Use the batch_reference to identify the batch and the upload_id to identify the specific failed payout that needs to be retried.

Updated 25 days ago

Did this page help you?