Add Wallet Balance

This API endpoint lets a partner add dollars to a member’s wallet balance, for example when the member converts points held by the partner. It is called server to server: it is restricted to the partner’s IP addresses and does not use a user API token.

Sending the same transaction_reference again returns the original load and does not add the amount twice, so retries are safe. Use this to recover a load whose outcome is unknown, for example after a timeout.

Request Body

• user_id (string): The member’s user ID.

• transaction_reference (string): The partner’s unique reference for this load (max 255 characters).

• amount (number): The amount to add in the member’s currency (minimum 0.01).

• description (string, optional): Shown in the member’s wallet history (max 255 characters).

Response

The wallet transaction. The fields a partner needs:

• transaction_id (string): The ID of the wallet transaction.

• to (string): The member’s user ID.

• amount (string): The amount added.

• transaction_type (string): 29 (Partner wallet load).

• description (string): The description sent in the request.

• external_transaction_reference (string): The reference sent in the request.

• created_at (string): When the wallet was loaded.

status is error, with a message explaining why, when the request is invalid, the user_id does not exist, or the load would take the wallet balance above A$1,000. Nothing is loaded in any of these cases.