Update the prepaid balance of the given organisation

Does a Top-Up, Reset or Credit note on the Prepaid balance of the given organisation. If there is a Balance in any other than the organisation’s currency, a Reset has to be issued first.

The API expects the following values:

amount: the amount that should be added to the organisations prepaid balance. even if another transaction type is selected, amount will always be added to the current balance.
transaction: the type of the transaction that has been done (top-up = 1, credit note = 2, balance reset = 3). this value has to be provided as a nested id field and is only a description for the transaction.
payment_option: the payment option that has to be associated with the request
external_payment_identifier: the identifier for an external payment transaction

Does a Top-Up, Reset or Credit note on the Prepaid balance of the given organisation. If there is a Balance in any other than the organisation's currency, a Reset has to be issued first. The API expects the following values: * `amount`: the amount that should be added to the organisations prepaid balance. even if another transaction type is selected, `amount` will always be added to the current balance. * `transaction`: the type of the transaction that has been done (top-up = 1, credit note = 2, balance reset = 3). this value has to be provided as a nested `id` field and is only a description for the transaction. * `payment_option`: the payment option that has to be associated with the request * `external_payment_identifier`: the identifier for an external payment transaction

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Path parameters

org_iddoubleRequired

Numerical ID of an organization

Request

This endpoint expects an object.

amountdoubleOptional

external_payment_identifierstringOptional

payment_optionobjectOptional

typeobjectOptional

Response

the balance has been updated with the specified amount.

Errors

Does a Top-Up, Reset or Credit note on the Prepaid balance of the given organisation. If there is a Balance in any other than the organisation’s currency, a Reset has to be issued first.

The API expects the following values:

amount: the amount that should be added to the organisations prepaid balance. even if another transaction type is selected, amount will always be added to the current balance.
transaction: the type of the transaction that has been done (top-up = 1, credit note = 2, balance reset = 3). this value has to be provided as a nested id field and is only a description for the transaction.
payment_option: the payment option that has to be associated with the request
external_payment_identifier: the identifier for an external payment transaction

1	curl -X POST https://cdn.emnify.net/api/v1/organisation/1.1/balance \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"amount": 12,
6	"external_payment_identifier": "ee72882-183883191d-131341",
7	"payment_option": {
8	"id": 1
9	},
10	"type": {
11	"id": 1
12	}
13	}'