AccountCreated
An account has been created and all KYC checks have been successfully completed. This is the first event received during the onboarding process.This is a legacy notification.
The ID of the newly-created account.Allowable values: A valid
accountIdThe ID that represents the link between the asynchronous request made to onboard an account and the webhook.Allowable values: A valid string
The date and time at which the webhook event was created, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe status of the account.Allowable values:
applicationPendingThe type of account.Allowable values:
Business, PersonalThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
AccountCreatedAccountActivated
An account has been opened and is ready to trade on, with active settlement details. This is the final event in the onboarding process.The ID that represents the link between the asynchronous request made to onboard an account and the webhook.Allowable values: A valid string
The date and time at which the resource was created, in ISO 8601 format without milliseconds.Allowable values: Format:
yyyy-MM-ddThh:mm:ssZDetails about the account.Allowable values: A valid
details object containing the following fields: countryOfRegistration, fourthLine, name, timezoneThe ID of the account.Allowable values: A valid
accountIdThe ID of the market that the account is in.Allowable values: ≤ 36 characters
The persona ID of the account’s Primary Owner.Allowable values: A valid
personaId (≤ 36 characters)The ID of the product.Allowable values: A valid
productId (≤ 36 characters)The status of the account.Allowable values:
activeThe type of account.Allowable values:
Business, PersonalThe account’s settlement details.Allowable values: A valid
settlementDetails object containing the following fields: currency, sortCode, accountNumber, ibans, accountName, bankName, bankAddress, balanceReferenceThe currency of the bank account, in ISO 4217 format.Allowable values: 3 characters
The sort code. This is only present for GBP budgets.Allowable values: ≤ 32 characters
The account number. This is only present for GBP budgets.Allowable values: ≤ 34 characters
Details about the IBAN and BIC.Allowable values: A valid
ibans object containing the following fields: iban, bicThe International Bank Account Number (IBAN).Allowable values: ≤ 100 characters
The Bank Identifier Code (BIC).Allowable values:
^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?The name of the bank account.Allowable values: A valid string
The name of the bank that the bank account is held with.Allowable values: A valid string
The address of the bank that the bank account is held with.Allowable values: A valid string
The balance reference.Allowable values: A valid string
The date and time at which the resource was last modified, in ISO 8601 format without milliseconds.Allowable values:
yyyy-MM-ddThh:mm:ssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
AccountActivatedPersonCreated
This is event is received when a new person has been created.The ID of the newly-created account.Allowable values: A valid
accountIdThe ID of the person.Allowable values: A valid string
The first name of the person created.Allowable values: A valid string
The last name of the person created.Allowable values: A valid string
The primary email address of the person created.Allowable values: A valid string
The primary mobile number of the person created.Allowable values: A valid string
The role of the person.Allowable values:
Owner Admin Viewer Accountant Balance admin Balance payer Balance userThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PersonCreatedIdentityVerificationRequested
Identity verification is required for an applicant as part of the onboarding process. This webhook provides an action URL that the applicant can use to complete their identity verification session.The ID of the onboarding application this webhook relates to. Provides context of the business application when identity verification is requested for an associated person.Allowable values: A valid UUID
The ID of the associated person for whom identity verification is being requested.
null for personal applications; populated when the request relates to an associated person on a business application.Allowable values: A valid UUID or nullFull name of the applicant who needs to complete identity verification.Allowable values: An existing
nameEmail address of the applicant who needs to complete identity verification.Allowable values: An existing
emailThe URL for the applicant to complete their identity verification session.Allowable values: A valid URL
The date and time at which the webhook event was created, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
IdentityVerificationRequestedKycInformationRequest
Additional documentation is required to complete the onboarding process for a personal application.The name of the account.Allowable values: An existing
nameThe email of the account.Allowable values: An existing
emailThe type of document that is required for the KYC process.Allowable values:
PROOF_OF_ADDRESS, PROOF_OF_IDENTITY, BANK_STATEMENTAdditional information about the document requested.Allowable values: ≤ 255 characters
The ID of the onboarding application this webhook relates to.Allowable values: A valid string
The ID that represents the link between the asynchronous request made to onboard an account and the webhook. This field is deprecated and will be removed in a future release. Use
applicationId instead.Allowable values: A valid stringThe date and time at which the webhook event was created, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
KycInformationRequestKybInformationRequest
Additional documentation is required to complete the onboarding process for a business and its associated people.The registered name of the business.Allowable values: A valid string
The trading names of the business.Allowable values: An array of valid strings
The person who submitted the business onboarding application.
The ID of the applicant.Allowable values: A valid string
The email address of the applicant.Allowable values: A valid email address
The full name of the applicant.Allowable values: A valid string
The types of documents required for the business.Allowable values:
PROOF_OF_ADDRESS, PROOF_OF_IDENTITY, BANK_STATEMENTThe directors, beneficial owners, or other individuals associated with the business who require additional documentation.
The ID of the associated person.Allowable values: A valid string
The full name of the associated person.Allowable values: A valid string
The types of documents required for this associated person.Allowable values:
PROOF_OF_ADDRESS, PROOF_OF_IDENTITY, BANK_STATEMENTAdditional information about the documents requested.Allowable values: ≤ 255 characters
The ID of the onboarding application this webhook relates to.Allowable values: A valid string
The date and time at which the webhook event was created, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
KybInformationRequestKycUpdate
When identity verification is required, theactionUrl field contains a link to a Guided identity verification check for the applicant to complete.
The name of the account.Allowable values: An existing
nameThe email of the account.Allowable values: An existing
emailThe ID of the account.Allowable values: An existing
accountIdThe status of the journey.Allowable values:
PENDING, DECLINED, COMPLETEDThe action required to progress application.Allowable values:
uploadProofOfAddress, identityVerificationCheck, notApplicableThe URL for the corresponding
requiredAction. Returns null when no action is required.Allowable values: A valid URL string or nullThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
KycUpdateApplicationStatusUpdated
The outcome of an onboarding application has been determined. This event fires for both approved and declined applications.The ID of the onboarding application this webhook relates to.Allowable values: A valid string
The full name of the applicant.Allowable values: A valid string
The outcome of the application.Allowable values:
approved, declinedThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
ApplicationStatusUpdatedAccountStatusUpdated
An account’s status has been updated.The ID of the account.Allowable values: An existing
accountIdThe new status of the account.Allowable values:
applicationPending, active, inactive, customerClosed, equalsFullClosed, equalsReadonlyClosed, identityVerificationRequired, restrictedThe date and time at which the webhook event was created, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
AccountStatusUpdatedRecipientCreated
A recipient was created.The ID of the account.Allowable values: An existing
accountIdWhether or not the banking information provided for the recipient was an International Bank Account Number (IBAN).Allowable values:
true, falseWhether or not the banking information provided for the recipient was a National Clearing Code (NCC).Allowable values:
true, falseWhether or not the banking information provided for the recipient was a SWIFT account.Allowable values:
true, falseThe name of the recipient.Allowable values: ≤ 256 characters
The reason for the transfer.Allowable values: ≤ 256 characters
The country of the recipient’s bank, in ISO 3166-1 format.Allowable values: ≤ 2 characters
The currency of the recipient’s bank account, in ISO 4217 format.Allowable values: 3 characters
The city of the recipient.Allowable values: ≤ 256 characters
The country of the recipient.Allowable values:
^[A-Z]{2}$The ID of the newly-created recipient. This is also known as the
recipientId.Allowable values: ≤ 36 charactersThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
RecipientCreatedRecipientDeleted
A recipient was deleted.The ID of the account.Allowable values: An existing
accountIdThe ID of the recipient that was deleted.Allowable values: ≤ 36 characters
The ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
RecipientDeletedPaymentBatchCreated
The batch group has successfully passed initial validation, with all recipient details verified. The batch is now ready for approval, and the recipient information is valid.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
Object containing the number of orders, and their unique currency codes.
The number of orders in the payment batch that was created.Allowable values: A valid number
The unique currency codes of the orders in the payment batch that was created.Allowable values: Valid
uniqueCurrencyCodesThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchCreatedPaymentBatchCancelled
The payment batch has been cancelled.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
Object containing the number of orders, and their unique currency codes.
The number of orders in the payment batch that was created.Allowable values: A valid number
The unique currency codes of the orders in the payment batch that was created.Allowable values: Valid
uniqueCurrencyCodesThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchCancelledPaymentBatchValidationError
Some payments within the batch have failed validation. This could be due to recipient details being incorrect. When this webhook is received, you can use thepaymentBatchId to view the alerts associated with the payments using the List payment batch payments API.
The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that failed validation.Allowable values: ≤ 36 characters
Object containing the number of orders, and their unique currency codes.
The number of orders in the payment batch.Allowable values: A valid number
The unique currency codes of the orders in the payment batch.Allowable values: Valid
uniqueCurrencyCodesThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchValidationErrorPaymentBatchProcessing
The payment batch has been confirmed, or the scheduled date has been reached.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
Object containing the number of orders, and their unique currency codes.
The number of orders in the payment batch that was created.Allowable values: A valid number
The unique currency codes of the orders in the payment batch that was created.Allowable values: Valid
uniqueCurrencyCodesThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchProcessingPaymentBatchCompleted
The payment batch has completed, and all payments within the batch have reached a final status.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
Object containing the number of orders, and their unique currency codes.
The number of orders in the payment batch that was created.Allowable values: A valid number
The unique currency codes of the orders in the payment batch that was created.Allowable values: Valid
uniqueCurrencyCodesThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchCompletedPaymentCreated
The payments have passed the initial checks, and no additional information is needed to proceed with the payout.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
The payment amount. Example:
100The currency code of which the recipient will receive payments in, ISO-4217 format. Example:
EURobject containing the recipient details such as
id, externalReference, type, name, displayName, subscribedEmailsThe ID of the recipient. Example:
8lqccfgmoThe type of account, either
individual,business or charity.The name of the recipient. Example:
John FrankDisplay name for the payee. Example:
ElectricianThis defines the Email addresses who will be sent notifications of payments to this recipient. This array requires a name and an email as input.
The method used for verifying the recipient.Allowable values:
sms_otp, phone, email, biometrics, otherThe recipient address object.
Type of the recipient’s address.
Street name of the recipient’s address. Example:
cannon StreetBuilding number of the recipient’s address. Example:
9Building name of the recipient’s address. Example:
AbramPostal code of the recipient’s address. Example:
SW1A 1AACity of the recipient’s address. Example:
LondonRegion of the recipient’s address. Example:
centralCountry code for the recipient’s address. Example:
GBThe recipient’s bank address object.
This represents the identifier of the bank, such as an Account Number or IBAN. Example:
55555555This represents the identifier of the recipient’s bank, such as an a Sort Code, BIC or Routing Number. This field is required if the accountIdentifier provided is not an IBAN. Example:
123456Identifier for intermediary bank. Example:
QBLCCCCVCountry code for the recipient’s bank address. Example:
GBThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentCreatedPaymentReturned
The payment has been refunded.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
The payment amount. Example:
100The currency code of which the recipient will receive payments in, ISO-4217 format. Example:
EURobject containing the recipient details such as
id, externalReference, type, name, displayName, subscribedEmailsThe ID of the recipient. Example:
8lqccfgmoThe type of account, either
individual,business or charity.The name of the recipient. Example:
John FrankDisplay name for the payee. Example:
ElectricianThis defines the Email addresses who will be sent notifications of payments to this recipient. This array requires a name and an email as input.
The method used for verifying the recipient.Allowable values:
sms_otp, phone, email, biometrics, otherThe recipient address object.
Type of the recipient’s address.
Street name of the recipient’s address. Example:
cannon StreetBuilding number of the recipient’s address. Example:
9Building name of the recipient’s address. Example:
AbramPostal code of the recipient’s address. Example:
SW1A 1AACity of the recipient’s address. Example:
LondonRegion of the recipient’s address. Example:
centralCountry code for the recipient’s address. Example:
GBThe recipient’s bank address object.
This represents the identifier of the bank, such as an Account Number or IBAN. Example:
55555555This represents the identifier of the recipient’s bank, such as an a Sort Code, BIC or Routing Number. This field is required if the accountIdentifier provided is not an IBAN. Example:
123456Identifier for intermediary bank. Example:
QBLCCCCVCountry code for the recipient’s bank address. Example:
GBThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentReturnedPaymentBatchOrderCreated
The group has been approved, processing will begin, and funds will be blocked. This is particularly useful for scheduled batches.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
The order ID of the payment batch that was created.Allowable values: ≤ 36 characters
An object containing details relating to the source currency such as
code, numberOfFees, valueOfFees, settlementTotalThe currency code of the source currency.Allowable values: A valid
codeThe number of fees.
The value of the fees.
The settlement amount.
An object containing details relating to the destination currency such as
code, numberOfPayments, valueOfPaymentsThe number of payments.
The value of the payments.
The ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchOrderCreatedPaymentBatchOrderCompleted
The group has been approved, and processing was successful. This is especially relevant for scheduled batches.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
The order ID of the payment batch that was created.Allowable values: ≤ 36 characters
An object containing details relating to the source currency such as
code, numberOfFees, valueOfFees, settlementTotalThe currency code of the source currency.Allowable values: A valid
codeThe number of fees.
The value of the fees.
The settlement amount.
An object containing details relating to the destination currency such as
code, numberOfPayments, valueOfPaymentsThe number of payments.
The value of the payments.
The ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchOrderCompletedPaymentBatchOrderCancelled
The batch order has been cancelled. This is especially relevant for scheduled batches.The ID of the account.Allowable values: An existing
accountIdThe ID of the payment batch that was created.Allowable values: ≤ 36 characters
The order ID of the payment batch that was created.Allowable values: ≤ 36 characters
An object containing details relating to the source currency such as
code, numberOfFees, valueOfFees, settlementTotalThe currency code of the source currency.Allowable values: A valid
codeThe number of fees.
The value of the fees.
The settlement amount.
An object containing details relating to the destination currency such as
code, numberOfPayments, valueOfPaymentsThe number of payments.
The value of the payments.
The ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
PaymentBatchOrderCancelledBoxCredited
A budget was credited.Sample payload
Event structure
The ID of the account.Allowable values: An existing
accountIdThe ID of the budget that was credited.Allowable values: An existing
budgetIdThe type of event that triggered the credit:
exchange: two currencies were exchanged on an Equals Money budget, and funds have been credited to the currency that the funds were exchanged intointernal_transfer: funds were received from another budget on your accountexternal_credit: funds were credited to the budget from an external sourceorders: funds were received from another budget on another Equals Money account
exchange, internal_transfer, external_credit, ordersThe remitter’s account identifier.Allowable values: A bank account number (
^\d{8,17}$) or IBAN (≤ 100 characters)The identifier of the remitter’s bank.Allowable values: A sort code (
^\d{6}$) or BIC (^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?)The address of the remitter’s bank.Allowable values: ≤ 109 characters
The name of the scheme.Allowable values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBANThe payment reference sent by the remitter.Allowable values: ≤ 256 characters
The address of the remitter.Allowable values: ≤ 256 characters
The name of the remitter.Allowable values: ≤ 256 characters
The name of the budget that was credited.Allowable values: An existing
budgetName (≤ 75 characters)The settlement amount.Allowable values: A valid number
The currency of the settlement, in ISO 4217 format.Allowable values: 3 characters
The name of the payment method used, in Open Banking’s standard format.Allowable values:
UK.OBIE.FPS, UK.OBIE.BACS, UK.OBIE.CHAPS, UK.OBIE.SWIFT, UK.OBIE.BalanceTransfer, UK.OBIE.SEPACreditTransferThe ID of the budget transaction.Allowable values: A valid integer
The ledger balance after the credit has been applied.Allowable values: A valid string
An incrementing number representing the latest balance.Allowable values: A valid string
The date and time at which the ledger was updated, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
BoxCreditedBoxCreditPending
A budget was credited, but the payment is still being processed.Sample payload
Event structure
The ID of the account.Allowable values: An existing
accountIdThe ID of the budget that was credited.Allowable values: An existing
budgetIdThe type of event that triggered the credit:
exchange: two currencies were exchanged on an Equals Money budget, and funds have been credited to the currency that the funds were exchanged intointernal_transfer: funds were received from another budget on your accountexternal_credit: funds were credited to the budget from an external sourceorders: funds were received from another budget on another Equals Money account
exchange, internal_transfer, external_credit, ordersThe remitter’s account identifier.Allowable values: A bank account number (
^\d{8,17}$) or IBAN (≤ 100 characters)The identifier of the remitter’s bank.Allowable values: A sort code (
^\d{6}$) or BIC (^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?)The address of the remitter’s bank.Allowable values: ≤ 109 characters
The name of the scheme.Allowable values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBANThe payment reference sent by the remitter.Allowable values: ≤ 256 characters
The address of the remitter.Allowable values: ≤ 256 characters
The name of the remitter.Allowable values: ≤ 256 characters
The name of the budget that was credited.Allowable values: An existing
budgetName (≤ 75 characters)The settlement amount.Allowable values: A valid number
The currency of the settlement, in ISO 4217 format.Allowable values: 3 characters
The name of the payment method used, in Open Banking’s standard format.Allowable values:
UK.OBIE.FPS, UK.OBIE.BACS, UK.OBIE.CHAPS, UK.OBIE.SWIFT, UK.OBIE.BalanceTransfer, UK.OBIE.SEPACreditTransferThe ID of the budget transaction.Allowable values: A valid integer
The ledger balance after the credit has been applied.Allowable values: A valid string
An incrementing number representing the latest balance.Allowable values: A valid string
The date and time at which the ledger was updated, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
BoxCreditPendingBoxDebited
A budget was debited.Sample payload
Event structure
The ID of the account.Allowable values: An existing
accountIdThe ID of the budget transaction.Allowable values: A valid integer
The ID of the budget that was debited.Allowable values: An existing
budgetIdThe name of the budget that was debited.Allowable values: An existing
budgetName (≤ 75 characters)The recipients’s account identifier.Allowable values: A bank account number (
^\d{8,17}$) or IBAN (≤ 100 characters)The identifier of the recipient’s bank.Allowable values: A sort code (
^\d{6}$) or BIC (^[a-zA-Z]{6}[a-zA-Z0-9]{2}([a-zA-Z0-9]{3})?)The address of the recipient’s bank.Allowable values: ≤ 109 characters
The ID of the order.Allowable values: A valid
orderId (12 characters)The name of the payment method used, in Open Banking’s standard format.Allowable values:
UK.OBIE.FPS, UK.OBIE.BACS, UK.OBIE.CHAPS, UK.OBIE.SWIFT, UK.OBIE.BalanceTransfer, UK.OBIE.SEPACreditTransferThe payment reference sent by the remitter.Allowable values: ≤ 256 characters
The name of the scheme.Allowable values:
UK.OBIE.SortCodeAccountNumber, UK.OBIE.IBANThe settlement amount.Allowable values: A valid number
The currency of the settlement, in ISO 4217 format.Allowable values: 3 characters
The type of event that triggered the debit:
exchange: two currencies were exchanged on an Equals Money budget, and funds have been debited from the currency that the funds were exchanged frominternal_transfer: funds were sent to another Equals Money budget, which is in the same currencyorders: an order was created to send funds from a budget
exchange, internal_transfer, ordersThe ledger balance after the debit has been applied.Allowable values: A valid string
An incremental number representing the latest balance.Allowable values: A valid string
The date and time at which the ledger was updated, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
BoxDebitedOrderCreated
An order was created.The ID of the account that created the order.Allowable values: An existing
accountIdThe ID of the newly-created order.Allowable values: A valid
orderId (12 characters)Details about the payment source.Allowable values:
amount, currencyDetails about the payment destination.Allowable values:
amount, currencyDetails about the recipient of the payment.Allowable values:
id, nameThe status of the order.Allowable values:
createdThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
OrderCreatedOrderCompleted
An order was successfully completed.The ID of the account that created the order.Allowable values: A valid
accountIdThe ID of the completed order.Allowable values: A valid
orderId (12 characters)Details about the payment source.Allowable values:
amount, currencyDetails about the payment destination.Allowable values:
amount, currencyDetails about the recipient of the payment.Allowable values:
id, nameThe status of the order.Allowable values:
completeThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
OrderCompletedOrderCancelled
An order was cancelled.The ID of the account that created the order.Allowable values: A valid
accountIdThe ID of the order.Allowable values: A valid
orderId (12 characters)Details about the payment.Allowable values: A valid
payments object containing the following fields: amount, externalReference, fundsSettled, fundsSettled, internalReference, payAllCharges, recipientId, recipientName, sepaThe status of the order.Allowable values:
cancelledThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
OrderCancelledFeeCreated
A standalone fee was created. For example, a fee for receiving an inbound credit.The ID of the account.Allowable values: A valid
accountIdThe ID of the order.Allowable values: A valid
orderId (12 characters)The currency of the fee, in ISO-4217 format.Allowable values: 3 characters
The related credit ID. If the fee was generated as a result of an inbound credit, this field will be populated with the box transaction ID of the related credit.Allowable values: A valid number
The date and time at which the resource was created, in ISO 8601 format without milliseconds.Allowable values: Format:
yyyy-MM-ddThh:mm:ssZThe amount of the fee.Allowable values: A valid number (
=>0)The reference of the fee. This is set by Equals Money.Allowable values: A valid string
The ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
FeeCreated3DSAuthRequest
3D Secure (3DS) authentication was requested.The ID of the transaction, as assigned by the issuing bank’s Access Control Server (ACS).Allowable values: 36 characters
The type of authentication request (AReq).Allowable values:
PAYMENT, RECURRING, INSTALLMENT, ADD_CARD, MAINTAIN_CARD, EMV_CARDHOLDER_VERIFICATIONThe ID of the budget associated with the card that 3DS authentication was requested for.Allowable values: An existing
budgetId (≤ 36 characters)The name of the budget.Allowable values: An existing
budgetName (≤ 75 characters)Details about the merchant with which the transaction is being made.Allowable values: A valid
cardAcceptor object containing the following fields: acquirerBin, country, merchantCategoryCode, merchantId, nameThe ID of the card.Allowable values: An existing
cardId (≤ 36 characters)The token that represents the card.Allowable values: ≤ 36 characters
The date and time at which the authentication request was created, in ISO 8601 format.Allowable values: Format:
yyyy-MM-ddThh:mm:ss.sssZThe numeric code of the currency used in the transaction, in ISO 4217 format. For example,
826 for GBP.Allowable values: 3 charactersThe maximum period of time, in minutes, that the 3DS Requestor will wait for an ACS to provide the results of a decoupled authentication transaction.Allowable values:
1-10080The 3DS protocol version used by the 3DS Requestor.Allowable values: 5-8 characters
The card network associated with the authentication request.Allowable values:
MASTERCARD, VISAThe ID of the person.Allowable values: An existing
personId (≤ 36 characters)The status of the authentication request.Allowable values:
PENDING, SUCCESS, FAILEDDetails about the transaction.Allowable values: A valid
transaction object containing the following fields: amount, currencyCode, exponent, subType, transactionTypeThe type of 3DS authentication, which describes the action to be taken.Allowable values:
authentication.decision, authentication.result, authentication.challenge.out_of_bandThe token that identifies the user.Allowable values: 36 characters
The ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
3DSAuthRequestCardTransaction
A card transaction has occurred.The ID of the account.Allowable values: A valid
accountIdThe date and time at which the card transaction event was recorded by the Equals Money platform, in ISO 8601 format without milliseconds.Allowable values: Format:
yyyy-MM-ddThh:mm:ssZDetails about the merchant.Allowable values: A valid
merchant object containing the following fields: name, id, subMerchantId, address, merchantCategoryDetails about the transaction.Allowable values: A valid
transaction object containing the following fields: transactionGroupId, boxTransactionId, budgetId, budgetName, personId, status, type, localAmount, localAmountCurrency, feeAmount, feeCurrency, exchangeRate, total, createdAt, updatedAt, transactionCreatedAt, transactionCompletedAt, responseDetails about the card.Allowable values: A valid
card object containing the following fields: id, type, name, lastDigits, createdAt, updatedAtThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
CardTransactionCardStateUpdated
A card’s state was changed.The name of the product.Allowable values: An existing
productNameThe ID of the account.Allowable values: An existing
accountIdThe ID of the card.Allowable values: An existing
cardIdThe groupID of the card.Allowable values: An existing
cardGroupIdThe type of the card.Allowable values: An existing
cardTypeThe state of the card.Allowable values: A valid
state object containing the following fields:ACTIVE REPLACED TERMINATED SUSPENDED UNACTIVATEDThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
CardStateUpdatedDigitalWalletTokenTransition
A digital wallet token’s state has changed. This can be either because a digital wallet token has been created, or because an existing token’s state has been updated.The ID of the account associated with the digital wallet token.Allowable values: A valid
accountIdThe ID of the card that the digital wallet token represents.Allowable values: An existing
cardId (≤ 36 characters)The type of card that the digital wallet token represents.Allowable values:
VIRTUAL_PAN, PHYSICAL_MSR, PHYSICAL_COMBOThe type of owner that the card belongs to: a budget (
BUDGET) or an individual (PEOPLE).Allowable values: BUDGET, PEOPLEThe token that represents the digital wallet token’s state, rather than the digital wallet itself.Allowable values: ≤ 36 characters
The method through which the digital wallet token transition was initiated.Allowable values:
TOKEN_SERVICE_PROVIDER, DIGITAL_WALLET, API, IVR, FRAUD, ADMIN, SYSTEM, TOKEN_SERVICE_PROVIDER_APIThe digital wallet token.Allowable values: A valid
digitalWalletToken (≤ 36 characters)The newly-updated state of the digital wallet token. For a newly-created digital wallet token, this is set to
REQUESTED.Allowable values: REQUESTED, REQUEST_DECLINED, ACTIVE, SUSPENDED, TERMINATEDThe type of digital wallet token transition that occurred.Allowable values:
fulfillment.requested, state.request_declined, state.activated, state.suspended, state.reinstated, state.terminated, card.swapThe fulfillment status of the digital wallet token transition.Allowable values:
DECISION_RED, DECISION_YELLOW, DECISION_GREEN, REJECTED, PROVISIONEDThe state of the card. Learn more about card states.Allowable values:
ACTIVE, SUSPENDED, TERMINATED, UNACTIVATED, REPLACEDThe date and time at which the resource was last modified, in ISO 8601 format without milliseconds.Allowable values:
yyyy-MM-ddThh:mm:ssZThe ID of the specific webhook event message. We’ll keep retrying to send an event with the same
messageId until we receive a 200 response from you.Allowable values: 36 charactersThe name of the webhook event type.Allowable values:
AccountCreated