API Reference

Create transaction for a member for a purse

post
https://trac-demo.stage.pebble.cloud/api/v1/orgs//members//purses//transactions

Post a new transaction to a specific purse

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
string
required
Body Params

A financial transaction involving a member purse. This can represent money being transferred into or out of the purse via a third party service.

Note that these transactions always involve a purse. If the transaction does not involve a purse it is an organizationTransaction.

Also note that core transaction fields are immutable, unlike most other kinds of records. The amount of a transaction cannot be changed once it is created.

tags
object

Tags that can be used to categorize the transaction.

externalIds
object

External IDs associated with the transaction.

string
required

The value of the transaction. The sign of this value is in relation to the member purse, so a positive amount will credit the purse and a negative amount will debit the purse. This is expected to be GROSS amount if VAT is applied

date-time
required

The date of the transaction in the originating system. Note that this will generally be earlier than the createdAt date in the metadata namespace, because there will be (sometimes significant) latency between transaction origination and it reaching Trac.

string

A code representing the type of account that a transaction is against, e.g. meal or hospitality. The absence of a code is equivalent to MEAL.

string

The transaction ID of the contra entry transaction used to cancel this transaction

date-time

Where the originating system has a concept of funds clearing, this is that date.

boolean

Whether the transaction has been reconciled or not

string

Description of the transaction

string

VAT applied to the amount. I.e. amount is gross amount and include the VAT

string
required

The general type of the transaction. Value can only be one of: cash, cheque, directDebit, directCredit, sale, epayment, cancellation

string

The name of the session this transaction was made in. E.g. lunch Used for credit handling.

private
object

For private use, do not use.

parentPay
object

For Parent Pay specific data

May be used to store additional parentpay data which is only later accessible in reporting.

arbor
object

For Arbor Payments specific data

May be used to store additional Arbor data which is only later accessible in reporting.

till
object

Data from goodtill

wisePay
object

Data for WisePay

tali
object

Data from tali

fourth
object

Data for Fourth

credit
object

Data relating to credit transactions and use of credit

sourceOfFunds
object

N.B. This is only for integrators who manage their own credits. Otherwise do not include it as it will affect your credit handling.

This parameter is for naming the credit sources used in a sale and the amounts taken from those credit sources. For each credit source, a credit purse will be upserted using the property name provided for the purse title and the slugified property name for the purse ID. A credit transaction will then be created against this credit purse for the amount given.

This parameter only applies to transactions created against the sales purse and that have a transaction type of 'sale'.

Responses

Updated 10 days ago

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago