Skip to main content

CounterpartyIncomingPayment webhook topic

ยท One min read

CounterpartyIncomingPayment webhook topicโ€‹

Funding you receive from a counterparty over bank rails now fires a webhook. Subscribe to the new CounterpartyIncomingPayment topic to reconcile deposits into a counterparty's account without polling the counterparty balance.

The event is sent after the payment has been recorded, so the counterparty balance already reflects it when the webhook arrives.

Included payloadโ€‹

FieldDescription
counterpartyIdThe counterparty whose account received the payment
merchantIdThe merchant that owns the counterparty
amountPayment amount in cents
currencyISO 4217 currency code
directioncredit for funds received, debit for funds withdrawn
methodThe bank rail, for example ach or wire
asOfDateBank settlement date, as YYYY-MM-DD
externalIncomingPaymentIdPayment identifier at the banking provider, for reconciliation against your bank records

If you subscribe with the "*" wildcard, you are already receiving this topic โ€” make sure your handler tolerates it.