Post a transaction for a member

post

https://trac-demo.stage.pebble.cloud/api/v1/orgs/{org_id}/members/{member_id}/transactions

This will post a new transaction to the member's default purse.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

org_id

string

required

member_id

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.

amount

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

transactionDate

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.

accountTypeCode

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.

cancellationTransactionId

string

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

clearedDate

date-time

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

reconciled

boolean

Whether the transaction has been reconciled or not

description

string

Description of the transaction

vatCode

string

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

type

string

required

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

session

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

Responses

201Created

400Bad Request

401Requires authentication

403Forbidden

404Resource not found

409Conflict