Framnex for Developers
    • Introduction
      • Overview
      • Quick Start
      • Authentication
      • Environments
    • Guides
      • Create an outgoing transfer
      • Handle webhooks
      • Transfer documents
    • Bulk Payouts
      • Upload bulk payout
      • List bulk payouts
      • Get bulk payout
      • List bulk payout items
      • Submit bulk payout
      • Cancel bulk payout
    • Cards
      • List card products
      • List cardholders
      • Issue card
      • List cards
      • Get card
      • Activate card
      • Freeze card
      • Unfreeze card
      • Close card
      • Set card limits
      • Create encryption envelope
      • Reveal card details
      • Set PIN
    • Card Transactions
      • List card transactions
      • Get card transaction
    • Accounts
      • Get account
      • List accounts
    • Auth
      • Get access token
    • Exchange Rates
      • Get exchange rate
    • Transfer Documents
      • Download document
      • List documents
      • Upload documents
    • Transfers
      • Create transfer
      • List transfers
      • Get transfer
    • Webhooks
      • Register webhook URL
      • Get webhook URL
      • List webhook deliveries
      • Get webhook delivery
      • Retry webhook delivery
    • Schemas
      • BankClientAPI
        • Account
        • AccountCredentials
        • AccountState
        • AccountType
        • AchCredentials
        • Address
        • BankDetails
        • BusinessEntity
        • ClientIntegrationAuthRequest
        • ClientIntegrationAuthResponse
        • ClientIntegrationErrorResponse
        • CreateExchangeTransferRequest
        • CreateOutgoingTransferRequest
        • CreateTransferRequest
        • CreateTransferType
        • CreatedResponse
        • Credentials
        • CredentialsState
        • CryptoCredentials
        • CustomerTransferStateDto
        • CryptoTransferDetails
        • ExchangeRate
        • DocumentDto
        • ExchangeTransferCancelledWebhookPayload
        • ExchangeTransfer
        • ExchangeTransferExecutedWebhookPayload
        • FasterUkCredentials
        • FedWireCredentials
        • IError
        • GasPaymentWebhookPayload
        • IReason
        • IncomingTransfer
        • LegalEntityType
        • ISuccess
        • IndividualEntity
        • IncomingTransferReceivedWebhookPayload
        • InternalCredentials
        • InternalServerError
        • OperationTypeDto
        • LegalEntity
        • LocalAEDCredentials
        • LocalXafCredentials
        • NeftCredentials
        • OutgoingTransfer
        • OutgoingTransferCancelledWebhookPayload
        • PageInfoDto
        • Participant
        • PaymentMethod
        • OutgoingTransferExecutedWebhookPayload
        • PagedFilterDto
        • TransferGas
        • TransferPagedDataDto
        • PixCredentials
        • TransferState
        • TransferType
        • ProblemDetails
        • TransferTypeDto
        • PaymentSystem
        • SepaCredentials
        • RegisterWebhookRequest
        • SortOrderDto
        • Result
        • SwiftCredentials
        • TedPayCredentials
        • Transfer
        • TransferDetails
        • TransferDetailsType
        • UaeFtsCredentials
        • UaeIppCredentials
        • ValidationProblemDetails
        • WebhookDelivery
        • WebhookDeliveryPagedDataDto
        • WebhookPayload
        • WebhookState
        • WebhookSubscription
        • WebhookType
        • YeePayKesLocalCredentials
        • YeePayMxnLocalCredentials
        • YeePayNgnLocalCredentials
      • BulkPayout
      • CardProduct
      • BulkPayoutState
      • Cardholder
      • BulkPayoutItemState
      • IssueCardRequest
      • BulkPayoutPagedDataDto
      • Card
      • BulkPayoutItemPagedDataDto
      • CardType
      • CardState
      • CardPagedDataDto
      • CloseCardRequest
      • SetCardLimitsRequest
      • CardEncryptionEnvelope
      • CardEncryptedDetailsRequest
      • CardEncryptedDetails
      • BulkPayoutFileFormat
      • SetCardPinRequest
      • BulkPayoutItemCounts
      • CardTransaction
      • CardTransactionState
      • BulkPayoutItem
      • CardTransactionPagedDataDto
      • CardNetwork
      • CardIssuanceFee
      • CardShipping
      • CardSpendingLimit
      • CardLimitInterval
      • CardCloseReason
      • CardSecretType
      • CardEncryptedValue
      • CardMerchant
      • CardWebhookType
      • CardWebhookPayload
      • CardIssuedWebhookPayload
      • CardIssuanceFailedWebhookPayload
      • CardStateChangedWebhookPayload
      • CardTransactionAuthorizedWebhookPayload
      • CardTransactionCompletedWebhookPayload
      • CardTransactionReversedWebhookPayload
      • BulkPayoutItemError
      • BulkPayoutFile
      • BulkPayoutFileItem
      • BulkPayoutWebhookType
      • BulkPayoutWebhookPayload
      • BulkPayoutValidatedWebhookPayload
      • BulkPayoutValidationFailedWebhookPayload
      • BulkPayoutCompletedWebhookPayload
    GuidesBaaS API ReferenceBank Client API Reference
    GuidesBaaS API ReferenceBank Client API Reference

    BulkPayoutWebhookPayload

    Base bulk payout webhook payload. The concrete type is selected by the type discriminator.
    Bulk payout webhooks are delivered to the URL registered with POST /integration/webhooks/subscription, with the same body, headers and signature as the other webhooks.

    {
        "type": "bulkPayoutValidated",
        "bulkPayoutId": "2ee645f2-a43b-4c67-91c2-c554a2daa782",
        "externalId": "string",
        "itemCount": 0,
        "currency": "string",
        "totalAmount": 0,
        "estimatedFeeAmount": 0,
        "expiresAt": "2019-08-24T14:15:22.123Z"
    }
    Built with