Skip to content

Message: payment.charge

Back to Index

Registers a charge for a given amount. If the payment maps an external payment provider, this message should be called after the charge has been approved by the provider.

Body
amountnumber

The amount that was charged.

authorizationNumberstring (optional)

If the charge was made against a previous authorization, provide the authorization number to automatically reduce the authorization amount.

transactionReferencestring (optional)

Reference to add to created Payment Journal entries. Usually a reference to an external verification of the charge.

Response Type string

Back to Index