Combining Webhooks and APIs
Making best use of the Modulr APIs and webhooks combined
Connected Data Fields
| Get Payments | Get Transactions | PAYIN Webhook | PAYOUT Webhook | |
|---|---|---|---|---|
| Modulr Payment ID (Pbid) | id | sourceId | PaymentId | PaymentId |
| Modulr Transaction ID (Tbid) | N/a | id | TransactionId | TransactionId |
| Receiving Account (ABid) Inbound Payment | accountNumber | account / id | AccountId | N/a |
| Payment External Reference | externalReference | N/a | SourceExternalReference | ExternalReference |
| Payment Scheme Identifier | schemeId | schemeInfo / id | schemeId | schemeInfo / Id |
| Payment Scheme Reference | originalReference paymentDescription (part of) Description | (part of) Description | (part of) PaymentReference | Reference |
Where information appears above as “(part of)”, it means that the field is concatenated with other data items. Payment scheme reference appears after the name of who the payment is from/to.
- Inbound example: “Payment from Hermione Grainger: For herbs”. Hermione Grainger is the Payer’s name on the account and the payment scheme reference used was “For herbs”.
Combining APIs and Webhooks
Internal Transfers
The Create a Payment endpoint is used to move money from one Modulr account to another Modulr account.
On the sending account (payer) there will be a payment and debit transaction and the PAYOUT webhook will trigger.
On the receiving account (payee) there will be a payment and a credit transaction and the PAYIN webhook will trigger.
Information is available via Get Payments for types of payments, status, etc.
Get Transactions provides all processed credits / debits against a single accountId.
Payments Out
The same Create a Payment endpoint is used to make a payment from a Modulr account to an external bank account.
On the sending Modulr account (payer) there will be a payment and debit transaction and the PAYOUT webhook will trigger via an update from the Faster Payment or SEPA scheme confirming success of each individual payment made. The Payment record is updated with the scheme reference.
Information is available via Get Payments for types of payments, status, etc.
Get Transactions provides all processed credits / debits against a single accountId.