Skip to main content

Create Transaction

POST 
/v1/admin/clients/:clientID/transactions

Endpoint to manually insert a transaction. Generally Transactions will be generated automatically when an event is triggered. This endpoint is useful to manually asign rewards to an user (for example).

Request​

Path Parameters

    clientID stringrequired

Body

    authId number
    clientId string
    data object

    data field can contain any JSON value. This field gives the request some flexibility.

    amount number
    flowId string
    leaderboards object
    dimensions string[]
    keys string[]
    message string
    groupId string

    useful to group transactions.

    isComparable boolean

    indicates if this transaction should be used to calculate Leaderboards or not.

    operation string

    indicates if this transaction should increase or decrease the balance. Allowed values are CREDIT and DEBIT.

    parentId string

    indicates that this transaction is child of the specified parentId (i.e. this transaction is a BOOSTER of another one).

    sourceSystem string
    type string

Responses​

Successful operation

Schema
    id uuid
    authId number
    clientId string
    data object

    data field can contain any JSON value. This field gives the request some flexibility.

    amount number
    flowId string
    leaderboards object
    dimensions string[]
    keys string[]
    message string
    groupId string

    useful to group transactions.

    isComparable boolean

    indicates if this transaction should be used to calculate Leaderboards or not.

    operation string

    indicates if this transaction should increase or decrease the balance. Allowed values are CREDIT and DEBIT.

    parentId uuid

    indicates that this transaction is child of the specified parentId (i.e. this transaction is a BOOSTER of another one).

    sourceSystem string
    type string
    createdAt date-time
Loading...