Virtual wallets

If your organizer account has the virtual wallets feature active, you can use the methods on this page to implement virtual transactions for your attendees.

Note

Before calling any of the methods on this page, you must obtain a valid authorization token. To learn about obtaining an authorization token, please read the Authentication section.

Create or credit virtual wallet

This method creates or credits a virtual wallet with a specified monetary amount.

HTTP request

POST https://l.oveit.com/api/wallet/credit

Request parameters

Parameter Description
token A valid access token, obtained in the Authentication step.
ticket_code (Optional, if the rfid_code parameter is used) The unique ticket code. This can be obtained by scanning the ticket's barcode or QR code. It is also listed in plain text on the ticket. Either this parameter or the rfid_code parameter below must be present in the request.
rfid_code (Optional, if the ticket_code parameter is used) The string tag stored on an RFID chip. To learn about associating tickets with RFID tags, read the section on RFID section
amount The amount to credit the wallet with.
currency The currency for the amount above.

Response example

{
    "transaction": {
        "id": 3877,
        "author_id": 1,
        "amount": "5.50",
        "currency": "USD",
        "type": "credit",
        "date": "2017-10-24T07:30:45+00:00",
        "canceled_at": null
    },
    "balance": [
        {
            "amount": "10.50",
            "currency": "USD"
        }
    ]
}

Debit virtual wallet

This method debits a virtual wallet with a specified monetary amount.

HTTP request

POST https://l.oveit.com/api/wallet/debit

Request parameters

See the credit method above.

Note

The amount parameter must have a positive value, even for the debit method.

Response example

See the credit method above.

Withdraw funds from wallet

The withdraw method is almost identical to the debit method above. However, unlike debit transactions, which are meant to be created when the attendee makes a purchase at the event, withdrawal transactions should be created when the attendee withdraws the money that is left in their wallet.

So, while the debit and withdraw methods serve the same purpose from the point of view of the wallet itself (that is, they lower the balance available for other transactions), from a reporting point of view debit transactions represent money that should go to vendors at the event, while withdraw transactions represent money that the attendee is cashing in.

HTTP request

POST https://l.oveit.com/api/wallet/withdraw

Request parameters

Parameter Description
token A valid access token, obtained in the Authentication step.
ticket_code (Optional, if the rfid_code parameter is used) The unique ticket code. This can be obtained by scanning the ticket's barcode or QR code. It is also listed in plain text on the ticket. Either this parameter or the rfid_code parameter below must be present in the request.
rfid_code (Optional, if the ticket_code parameter is used) The string tag stored on an RFID chip. To learn about associating tickets with RFID tags, read the section on RFID section.
currency The currency of the virtual wallet balance section to completely withdraw.

Note

Please note the lack of an amount parameter. When calling the withdraw method, all funds for the specified currency are withdrawn from the wallet.

Response example

{
    "transaction": {
        "id": 3883,
        "author_id": 1,
        "amount": "-100.00",
        "currency": "USD",
        "type": "withdraw",
        "date": "2017-10-24T07:55:23+00:00",
        "canceled_at": null
    },
    "balance": [
        {
            "amount": "0.00",
            "currency": "USD"
        }
    ]
}

Cancel a transaction

Use this method to cancel a previous transaction.

HTTP request

POST https://l.oveit.com/api/wallet/cancel

Request parameters

Parameter Description
token A valid access token, obtained in the Authentication step.
ticket_code (Optional, if the rfid_code parameter is used) The unique ticket code. This can be obtained by scanning the ticket's barcode or QR code. It is also listed in plain text on the ticket. Either this parameter or the rfid_code parameter below must be present in the request.
rfid_code (Optional, if the ticket_code parameter is used) The string tag stored on an RFID chip. To learn about associating tickets with RFID tags, read the section on RFID section
id The unique transaction ID. The transaction IDs are part of the response for all the methods above.

Get virtual wallet balance

This method returns the balance and transaction history for an individual wallet.

HTTP request

POST https://l.oveit.com/api/wallet/balance

Request parameters

Parameter Description
token A valid access token, obtained in the Authentication step.
ticket_code (Optional, if the rfid_code parameter is used) The unique ticket code. This can be obtained by scanning the ticket's barcode or QR code. It is also listed in plain text on the ticket. Either this parameter or the rfid_code parameter below must be present in the request.
rfid_code (Optional, if the ticket_code parameter is used) The string tag stored on an RFID chip. To learn about associating tickets with RFID tags, read the section on RFID section

Response example

{
    "balance": [
        {
            "amount": "125.00",
            "currency": "USD"
        },
        {
            "amount": "50.00",
            "currency": "EUR"
        }
    ],
    "transactions": [
        {
            "id": 1,
            "author_id": 509,
            "amount": "200.00",
            "currency": "USD",
            "type": "credit",
            "date": "2017-06-14T08:35:03+00:00",
            "canceled_at": null
        },
        {
            "id": 2,
            "author_id": 509,
            "amount": "50.00",
            "currency": "EUR",
            "type": "credit",
            "date": "2017-06-14T08:37:03+00:00",
            "canceled_at": null
        },
        {
            "id": 3,
            "author_id": 510,
            "amount": "-50.00",
            "currency": "USD",
            "type": "debit",
            "date": "2017-06-14T08:37:10+00:00",
            "canceled_at": null
        },
        {
            "id": 4,
            "author_id": 510,
            "amount": "-25.00",
            "currency": "USD",
            "type": "debit",
            "date": "2017-06-14T08:37:11+00:00",
            "canceled_at": null
        }
    ]
}

Note

  • The balance response property is an array of objects. Each object represents the balance for each currency you have recorded transactions in.
  • The amount property has a negative value for debit transactions.
  • The balance is also returned as part of the response for any of the other methods in this section.