Payment events

The following Payment Events are available to Subscribe to in the Events API. For more information about how to subscribe to Events, see the main page for events: Events API and Subscribing to Events

INVOICE_PAYMENT_RECEIVED - A Payment connected to an Invoice has been made

InvoicePaymentReceivedPayload{
invoiceNumber* integer($int64)
orderId* integer($int64)
paymentDate* string($timestamp)
effectiveBookingDate string($date)
bookingDate string($date)
amountInCents* integer($int64)
currencyCode* string
orderReferenceId* string
isoPaymentDate string($date-time)
}

PAYMENT_AUTHORIZED - A created Payment has been authorized successfully

PaymentAuthorizedPayload{
orderId integer($int64)
orderStatus string
orderReferenceId string
paymentId* integer($int64)
remoteId* string
}

CARD_PAYMENT_AUTHORIZED - A created Card Payment has been authorized successfully

PaymentAuthorizedPayload{
orderId integer($int64)
orderStatus string
orderReferenceId string
paymentId* integer($int64)
remoteId* string
}

PAYMENT_SETTLED - A created Payment has been settled successfully

PaymentSettledPayload{
orderId integer($int64)
orderStatus string
orderReferenceId string
paymentId* integer($int64)
remoteId* string
settlementDate* string($date-time)
}

CARD_PAYMENT_SETTLED - A created Card Payment has been settled successfully

PaymentSettledPayload{
orderId integer($int64)
orderStatus string
orderReferenceId string
paymentId* integer($int64)
remoteId* string
settlementDate* string($date-time)
}

STORED_PAYMENT_DETAILS_UPDATED - A created session for payment details has been updated

StoredPaymentDetailsUpdatedPayload{
storedPaymentDetailsId* string
status* string
}

SWISH_STATUS_UPDATED - A created swish payment has been updated

SwishStatusUpdatedPayload{
paymentId* integer($int64)
externalPaymentReference* string
status* string
Enum:
[ INITIALIZED, PAID, DECLINED, CANCELLED, ERROR ]
errorCode string
errorMessage string
}

WRITE_OFF_PAYMENT_CREATED - An write-off payment has been added to an invoice

WriteOffPaymentPayload{
writeOffAmount* integer($int64)
invoiceNumber* string
}
Missing an Event?

We would love to get request for new Events, create a ticket in our support portal and we will look into it!


Powered by DeveloperHub
On This Page
Payment events