API open badge Help

Credit Transactions

Credit usage, such as credits consumed for badge assignment, remaining balance, and transaction history.

Credits deduction flow

Wallet and Credits
Single Badge Assignment
Bulk Badge Assignment
Add Transaction to List
Deduct Credits from Wallet
Deduct Total Credits as Single Sum
Record Bulk Transaction as Single Entry
Send Credits deduction Confirmation Email

Values returned

Field

Type

Description

id

string

Unique identifier of the credit transaction.

organization_id

string

Identifier of the organization associated with this credit transaction.

user_id

string

Identifier of the user who initiated the credit transaction.

description

string

Description of the credit transaction.

credits

integer

Number of credits involved in the transaction.

currency

string

Currency code used for the transaction.


Possible values: EUR

amount

string

Monetary value of the transaction in the specified currency.

status

ENUM

Current status of the credit transaction.


Possible values: request, accepted, declined.

created_at

timestamp

Date and time when the credit transaction was created


Format returned is YYYY-MM-DD HH:MM:SS, UTC timezone

updated_at

timestamp

Date and time when the credit transaction was updated


Format returned is YYYY-MM-DD HH:MM:SS, UTC timezone

Last modified: 12 November 2024