{"openapi":"3.1.0","info":{"title":"Webhooks","version":"1.0.0"},"paths":{},"webhooks":{"subpackage_payOutWebhooks.payoutTransactionVoidedCancelled":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionVoidedCancelled","summary":"Transaction Voided","description":"Triggered when a Pay Out transaction (a payout) is voided or canceled.\n\nNotification name: `payout_transaction_voidedcancelled`\nLegacy notification name: `PayOutCanceled`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionVoidedCancelledContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionProcessing":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionProcessing","summary":"Pay Out Transaction Processing","description":"Triggered when a pay out transaction enters processing status.\n\nNotification name: `payout_transaction_processing`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionProcessingContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionProcessed":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionProcessed","summary":"Pay Out Transaction Processed","description":"Triggered when a pay out transaction is processed.\n\nNotification name: `payout_transaction_processed`\nLegacy notification name: `PayOutProcessed`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionProcessedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionOnHold":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionOnHold","summary":"Pay Out Transaction On Hold","description":"Triggered when a pay out transaction is placed on hold.\n\nNotification name: `payout_transaction_onhold`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionOnHoldContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionReleased":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionReleased","summary":"Pay Out Transaction Released","description":"Triggered when a pay out transaction is released from hold.\n\nNotification name: `payout_transaction_released`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionReleasedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionRecovered":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionRecovered","summary":"Pay Out Transaction Recovered","description":"Triggered when a pay out transaction is recovered.\n\nNotification name: `payout_transaction_recovered`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionRecoveredContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionInitiated":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionInitiated","summary":"Pay Out Transaction Initiated","description":"Triggered when a pay out transaction is initiated.\n\nNotification name: `payout_transaction_initiated`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionInitiatedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionAuthorized":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionAuthorized","summary":"Pay Out Transaction Authorized","description":"Triggered when a pay out transaction is authorized.\n\nNotification name: `payout_transaction_authorized`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionAuthorizedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionApprovedCaptured":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionApprovedCaptured","summary":"Pay Out Transaction Approved/Captured","description":"Triggered when a pay out transaction is approved and captured.\n\nNotification name: `payout_transaction_approvedcaptured`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionApprovedCapturedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionDeclined":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionDeclined","summary":"Pay Out Transaction Declined","description":"Triggered when a pay out transaction is declined.\n\nOn a failed capture, the payload includes a `Reason` field explaining why the capture didn't succeed.\n\nNotification name: `payout_transaction_declined`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionDeclinedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionTechnicalDecline":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionTechnicalDecline","summary":"Pay Out Transaction Technical Decline","description":"Triggered when a pay out transaction is declined due to technical reasons.\n\nThe payload includes a `Reason` field explaining why the capture didn't succeed.\n\nNotification name: `payout_transaction_technicaldecline`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionTechnicalDeclineContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionFailed":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionFailed","summary":"Pay Out Transaction Failed","description":"Triggered when a pay out transaction fails.\n\nNotification name: `payout_transaction_failed`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionFailedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionError":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionError","summary":"Pay Out Transaction Error","description":"Triggered when a pay out transaction encounters an error.\n\nOn a failed capture, the payload includes a `Reason` field explaining why the capture didn't succeed.\n\nNotification name: `payout_transaction_error`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionErrorContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionPaid":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionPaid","summary":"Pay Out Transaction Paid","description":"Triggered when a pay out transaction is paid.\n\nNotification name: `payout_transaction_paid`\nLegacy notification name: `PayOutPaid`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionPaidContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionReturned":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionReturned","summary":"Pay Out Transaction Returned","description":"Triggered when a pay out transaction is returned.\n\nNotification name: `payout_transaction_returned`\nLegacy notification name: `PayOutReturned`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionReturnedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionRejected":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionRejected","summary":"Pay Out Transaction Rejected","description":"Triggered when a pay out transaction is rejected.\n\nOn a failed capture, the payload includes a `Reason` field explaining why the capture didn't succeed.\n\nNotification name: `payout_transaction_rejected`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionRejectedContent"}}}}}},"subpackage_payOutWebhooks.payoutTransactionDuplicated":{"post":{"operationId":"subpackage_payOutWebhooks.payoutTransactionDuplicated","summary":"Pay Out Transaction Duplicated","description":"Triggered when Payabli's duplicate detection flags a pay out transaction as a potential duplicate. The payload identifies the affected transactions and the details of the anomaly.\n\nNotification name: `payout_transaction_duplicated`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutTransactionDuplicatedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementPending":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementPending","summary":"Pay Out Batch Settlement Pending","description":"Triggered when a pay out batch settlement is pending.\n\nNotification name: `payout_batch_settlement_pending`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementPendingContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementInTransit":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementInTransit","summary":"Pay Out Batch Settlement In Transit","description":"Triggered when a pay out batch settlement is in transit.\n\nNotification name: `payout_batch_settlement_intransit`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementInTransitContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementTransferred":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementTransferred","summary":"Pay Out Batch Settlement Transferred","description":"Triggered when a pay out batch settlement is transferred.\n\nNotification name: `payout_batch_settlement_transferred`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementTransferredContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementFunded":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementFunded","summary":"Pay Out Batch Settlement Funded","description":"Triggered when a pay out batch settlement is funded.\n\nNotification name: `payout_batch_settlement_funded`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementFundedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementResolved":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementResolved","summary":"Pay Out Batch Settlement Resolved","description":"Triggered when a pay out batch settlement is resolved.\n\nNotification name: `payout_batch_settlement_resolved`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementResolvedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementException":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementException","summary":"Pay Out Batch Settlement Exception","description":"Triggered when a pay out batch settlement encounters an exception.\n\nNotification name: `payout_batch_settlement_exception`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementExceptionContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementAchReturnChargeback":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementAchReturnChargeback","summary":"Pay Out Batch Settlement ACH Return/Chargeback","description":"Triggered when a pay out batch settlement has an ACH return or chargeback.\n\nNotification name: `payout_batch_settlement_achreturnchargeback`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementAchReturnChargebackContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementHeld":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementHeld","summary":"Pay Out Batch Settlement Held","description":"Triggered when a pay out batch settlement is held.\n\nNotification name: `payout_batch_settlement_held`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementHeldContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchSettlementReleased":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchSettlementReleased","summary":"Pay Out Batch Settlement Released","description":"Triggered when a pay out batch settlement is released from hold.\n\nNotification name: `payout_batch_settlement_released`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchSettlementReleasedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchFunded":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchFunded","summary":"Pay Out Batch Funded","description":"Triggered when a pay out batch is funded (replaces payoutbatchfunded).\n\n- Notification name: `payout_batch_funded`\n- Legacy notification name: `payoutbatchfunded`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchFundedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchProcessed":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchProcessed","summary":"Pay Out Batch Processed","description":"Triggered when a pay out batch is processed (replaces payoutbatchprocessed).\n\n- Notification name: `payout_batch_processed`\n- Legacy notification name: `payoutbatchprocessed`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchProcessedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchPaid":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchPaid","summary":"Pay Out Batch Paid","description":"Triggered when a pay out batch is paid (replaces payoutbatchpaid).\n\n- Notification name: `payout_batch_paid`\n- Legacy notification name: `payoutbatchpaid`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchPaidContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchFundPending":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchFundPending","summary":"Pay Out Batch Fund Pending","description":"Triggered when a pay out batch has funding pending (replaces payoutbatchfundingpending).\n\n- Notification name: `payout_batch_fundpending`\n- Legacy notification name: `payoutbatchfundingpending`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchFundPendingContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchOpen":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchOpen","summary":"Pay Out Batch Open","description":"Triggered when a pay out batch is opened.\n\nNotification name: `payout_batch_open`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchOpenContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchClosed":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchClosed","summary":"Pay Out Batch Closed","description":"Triggered when a pay out batch is closed.\n\n- Notification name: `payout_batch_closed`\n- Legacy notification name: `payoutbatchclosed`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchClosedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchNotClosed":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchNotClosed","summary":"Pay Out Batch Not Closed","description":"Triggered when a pay out batch is not closed.\n\nNotification name: `payout_batch_notclosed`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchNotClosedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchCancelled":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchCancelled","summary":"Pay Out Batch Cancelled","description":"Triggered when a pay out batch is cancelled (replaces payoutbatchcancelled).\n\n- Notification name: `payout_batch_cancelled`\n- Legacy notification name: `payoutbatchcancelled`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchCancelledContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchTransferred":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchTransferred","summary":"Pay Out Batch Transferred","description":"Triggered when a pay out batch is transferred.\n\nNotification name: `payout_batch_transferred`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchTransferredContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchResolved":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchResolved","summary":"Pay Out Batch Resolved","description":"Triggered when a pay out batch is resolved.\n\nNotification name: `payout_batch_resolved`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchResolvedContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchOnHold":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchOnHold","summary":"Pay Out Batch On Hold","description":"Triggered when a pay out batch is placed on hold.\n\nNotification name: `payout_batch_onhold`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchOnHoldContent"}}}}}},"subpackage_payOutWebhooks.payoutBatchReleased":{"post":{"operationId":"subpackage_payOutWebhooks.payoutBatchReleased","summary":"Pay Out Batch Released","description":"Triggered when a pay out batch is released from hold.\n\nNotification name: `payout_batch_released`","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutBatchReleasedContent"}}}}}}},"components":{"schemas":{"PayoutTransactionVoidedCancelledContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutVoidedCancelled"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","RefundAmount"],"title":"PayoutTransactionVoidedCancelledContent"},"PayoutTransactionProcessingContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutProcessing"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionProcessingContent"},"PayoutTransactionProcessedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutProcessed"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionProcessedContent"},"PayoutTransactionOnHoldContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutOnHold"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionOnHoldContent"},"PayoutTransactionReleasedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutReleased"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionReleasedContent"},"PayoutTransactionRecoveredContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutRecovered"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionRecoveredContent"},"PayoutTransactionInitiatedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutInitiated"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionInitiatedContent"},"PayoutTransactionAuthorizedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutAuthorized"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionAuthorizedContent"},"PayoutTransactionApprovedCapturedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutApprovedCaptured"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionApprovedCapturedContent"},"PayoutTransactionDeclinedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutDeclined"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"},"FundingSource":{"type":"string","description":"The funding source used to fund the payout."},"PaymentStatus":{"type":"string","description":"The resulting payment status for the transaction after the capture attempt."},"Reason":{"type":"string","description":"The reason the payout capture didn't succeed."}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount","FundingSource","PaymentStatus","Reason"],"title":"PayoutTransactionDeclinedContent"},"PayoutTransactionTechnicalDeclineContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutTechnicalDecline"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"},"FundingSource":{"type":"string","description":"The funding source used to fund the payout."},"PaymentStatus":{"type":"string","description":"The resulting payment status for the transaction after the capture attempt."},"Reason":{"type":"string","description":"The reason the payout capture didn't succeed."}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount","FundingSource","PaymentStatus","Reason"],"title":"PayoutTransactionTechnicalDeclineContent"},"PayoutTransactionFailedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutFailed"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionFailedContent"},"PayoutTransactionErrorContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutError"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"},"FundingSource":{"type":"string","description":"The funding source used to fund the payout."},"PaymentStatus":{"type":"string","description":"The resulting payment status for the transaction after the capture attempt."},"Reason":{"type":"string","description":"The reason the payout capture didn't succeed."}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","entryPoint","RefundAmount","FundingSource","PaymentStatus","Reason"],"title":"PayoutTransactionErrorContent"},"PayoutTransactionPaidContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutPaid"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionPaidContent"},"PayoutTransactionReturnedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutReturned"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount"],"title":"PayoutTransactionReturnedContent"},"PayoutTransactionRejectedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutRejected"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"TransId":{"type":"string","description":"Unique transaction identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"CustomerId":{"type":"string","description":"The unique identifier for the customer"},"CustomerNumber":{"type":"string","description":"Internal customer identifier"},"Method":{"type":"string","description":"Payment processing method"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"},"TraceNumber":{"type":["string","null"],"description":"Trace number for the vendor ACH credit"},"entryPoint":{"type":"string","description":"System entry point identifier"},"RefundAmount":{"type":"string","description":"Leftover amount not accepted by the vendor when a payout is partially accepted"},"FundingSource":{"type":"string","description":"The funding source used to fund the payout."},"PaymentStatus":{"type":"string","description":"The resulting payment status for the transaction after the capture attempt."},"Reason":{"type":"string","description":"The reason the payout capture didn't succeed."}},"required":["Event","Paypoint","Text","TransId","TotalAmount","CustomerId","CustomerNumber","Method","ExternalPaypointId","TraceNumber","entryPoint","RefundAmount","FundingSource","PaymentStatus","Reason"],"title":"PayoutTransactionRejectedContent"},"PayoutTransactionDuplicatedContent":{"type":"object","properties":{"anomalyType":{"type":"string","description":"The type of anomaly detected. For a duplicated-transaction event, this is `DuplicateTransaction`."},"anomalyStatus":{"type":"string","description":"The review status of the anomaly, for example `Active`, `Reviewed`, or `Ignored`."},"affectedIds":{"type":"string","description":"A JSON-encoded array, sent as a string, of the IDs of the transactions flagged as duplicates."},"gateway":{"type":"string","description":"Identifier of the gateway associated with the affected transactions"},"duplicateCount":{"type":"integer","description":"The number of transactions flagged as duplicates"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the anomaly was detected, in ISO 8601 format"},"paypointId":{"type":"integer","format":"int64","description":"The unique identifier of the paypoint"},"vendorId":{"type":"integer","format":"int64","description":"The unique identifier of the vendor"},"vendorName":{"type":"string","description":"The vendor's name"},"vendorNumber":{"type":"string","description":"The vendor's vendor number"},"event":{"type":"string","enum":["PayoutTransactionDuplicated"],"description":"Event type identifier"},"paypoint":{"type":"string","description":"The legal name of the paypoint"},"text":{"type":"string","description":"Human-readable description of the event"},"contactUs":{"type":"string","description":"The paypoint's contact information"},"externalPaypointId":{"type":"string","description":"External paypoint system identifier. Omitted when not set."},"entryPoint":{"type":"string","description":"The paypoint's entrypoint identifier"}},"title":"PayoutTransactionDuplicatedContent"},"PayoutBatchSettlementPendingContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferPending"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementPendingContent"},"PayoutBatchSettlementInTransitContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferInTransit"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementInTransitContent"},"PayoutBatchSettlementTransferredContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferTransferred"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementTransferredContent"},"PayoutBatchSettlementFundedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferFunded"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementFundedContent"},"PayoutBatchSettlementResolvedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferResolved"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementResolvedContent"},"PayoutBatchSettlementExceptionContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferException"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementExceptionContent"},"PayoutBatchSettlementAchReturnChargebackContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferAchReturnChargeback"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementAchReturnChargebackContent"},"PayoutBatchSettlementHeldContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferHeld"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementHeldContent"},"PayoutBatchSettlementReleasedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["TransferReleased"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"transferId":{"type":"string","description":"Unique transfer identifier"},"NetAmount":{"type":"string","description":"Net transaction amount in currency format"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"RtAmount":{"type":"string","description":"Return amount in currency format"},"transferTime":{"type":"string","description":"Transfer timestamp in M/D/YYYY H:mm:ss format"},"batchId":{"type":"string","description":"Unique batch identifier"},"ContactUs":{"type":"string","description":"Contact information string"},"batchNumber":{"type":"string","description":"Batch number identifier (UUID format)"},"entryPoint":{"type":"string","description":"System entry point identifier"},"ExternalPaypointId":{"type":["string","null"],"description":"External paypoint system identifier"}},"required":["Event","Paypoint","Text","transferId","NetAmount","TotalAmount","RtAmount","transferTime","batchId","ContactUs","batchNumber","entryPoint","ExternalPaypointId"],"title":"PayoutBatchSettlementReleasedContent"},"PayoutBatchFundedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchFunded"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchFundedContent"},"PayoutBatchProcessedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchProcessed"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchProcessedContent"},"PayoutBatchPaidContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchPaid"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchPaidContent"},"PayoutBatchFundPendingContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchFundingPending"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchFundPendingContent"},"PayoutBatchOpenContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchOpen"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchOpenContent"},"PayoutBatchClosedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchClosed"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchClosedContent"},"PayoutBatchNotClosedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchNotClosed"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchNotClosedContent"},"PayoutBatchCancelledContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchCancelled"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchCancelledContent"},"PayoutBatchTransferredContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchTransferred"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchTransferredContent"},"PayoutBatchResolvedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchResolved"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchResolvedContent"},"PayoutBatchOnHoldContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchOnHold"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchOnHoldContent"},"PayoutBatchReleasedContent":{"type":"object","properties":{"Event":{"type":"string","enum":["PayOutBatchReleased"],"description":"Event type identifier"},"Paypoint":{"type":"string","description":"The name of the merchant/paypoint"},"Text":{"type":"string","description":"Human-readable description of the event"},"BatchId":{"type":"string","description":"Unique batch identifier"},"TotalAmount":{"type":"string","description":"Total transaction amount including fees"},"Method":{"type":"string","description":"Payment processing method"},"entryPoint":{"type":"string","description":"System entry point identifier"}},"required":["Event","Paypoint","Text","BatchId","TotalAmount","Method","entryPoint"],"title":"PayoutBatchReleasedContent"}}}}