v1

latestOpenAPI 3.0.32026-07-2476126451.9 KB

v1.1

Cancel bulk payout request item

post/api/v1.4/payout/bulk/requests/{request_id}/items/{merchant_reference}/cancel/

Path parameters

merchant_referencestring required

A unique identifier for the bulk payout request item within a bulk request.

request_idstring required

A unique identifier for the bulk payout request

Response

idstring required

merchant_referencestring required

Unique reference for the item

statusstring

linked_intent_idstring nullable required

Linked intent for the item; this field will be filled when the item is processed and its status changes to INTENT_CREATED

scheduled_datestring date-time

Scheduled date for the payout intent to be processed

createdstring date-time required

scheduled_atstring date-time nullable

cancelled_atstring date-time nullable

validation_failed_atstring date-time nullable

intent_creation_failed_atstring date-time nullable

intent_created_atstring date-time nullable

{"stackTrail":"components:schemas:BulkPayoutRequestItemDetail:properties:payout_intent_details","oasType":"schema","type":"unknown","description":"Payout intent details to be used while creating payout intent"}

{"stackTrail":"components:schemas:BulkPayoutRequestItemDetail:properties:validation_result","oasType":"schema","type":"unknown","description":"Validation result for the item"}