Create Balance Transaction
Add a Transaction to a Balance. This endpoint allows you to create a new Transaction amount for a Balance. This amount then becomes available at billing for draw-down to cover charges due. The Transaction details should be provided in the request body.
Before you can add a Transaction amount, you must first set up Transaction Types at the Organization Level - see the Transaction Type section in this API Reference for more details. You can then use this call to add an instance of a Transaction Type to a Balance.
Note: If you have a customer whose payment is in a different currency to the Balance currency, you can use the paid and paidCurrency request parameters to record the amount paid and alternative currency respectively. For example, you might add a Transaction amount of 200 USD to a Balance on a customer Account where the customer actually paid you 50 units in virtual currency X.
Authorizations
m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.
The authorizationCode flow controls access for human users via the m3ter Console application.
Path Parameters
The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.
The unique identifier (UUID) for the Balance to which you want to add a transaction.
Body
The financial value of the transaction.
The version number of the entity:
- Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
- Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
A brief description explaining the purpose and context of the transaction.
The payment amount if the payment currency differs from the Balance currency.
The currency code of the payment if it differs from the Balance currency. For example: USD, GBP or EUR.
The unique identifier (UUID) of the transaction type. This is obtained from the list of created Transaction Types within the Organization Configuration.
36The date (in ISO 8601 format) when the Balance transaction was applied.
The date (in ISO 8601 format) when the transaction occurred.
Response
Returns the created Balance transaction
The UUID of the entity.
The version number:
- Create: On initial Create to insert a new entity, the version is set at 1 in the response.
- Update: On successful Update, the version is incremented by 1 in the response.
A brief description explaining the purpose or context of the transaction.
The financial value of the transaction, as recorded in the balance.
The actual payment amount if the payment currency differs from the Balance currency.
The currency code such as USD, GBP, EUR of the payment, if it differs from the balance currency.
The type of entity associated with the Transaction - identifies who or what was responsible for the Transaction being added to the Balance - such as a User, a Service User, or a Bill.
BILL, COMMITMENT, USER, SERVICE_USER, SCHEDULER The unique identifier (UUID) for the entity associated with the Transaction, as specified by the entityType.
The unique identifier (UUID) for the Transaction type. This is obtained from the list of created Transaction Types within the Organization Configuration.
The date (in ISO 8601 format) when the balance transaction was applied, i.e., when the balance was affected.
The date (in ISO 8601 format) when the transaction was recorded in the system.
The date and time (in ISO 8601 format) when the balance transaction was first created.
The date and time (in ISO 8601 format) when the balance transaction was last modified.
The unique identifier (UUID) for the user who created the balance transaction.
The unique identifier (UUID) for the user who last modified the balance transaction.