API Reference

Update a member transaction

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

Only transaction metadata can be updated.

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

You must provide the If-Unmodified-Since header. See Optimistic Concurrency Control

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
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

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

The state of the transaction, indicating if it has been processed by the rules or is still awaiting processing. Can either be 'notProcessed' or 'processed'.

string

Description of the transaction

string

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

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

Headers
date-time
required

This header is used in all PUT methods to implement Optimistic Concurrency Control. You must specify the date and time of the version of the resource that you wish to modify. This will be checked on the server and, if the resource has been updated subsequently, the update will be refused with a 412 Precondition Failed.

See RFC7232.

Note: While the above reference gives examples of using HTTP-Date format for the date in the header, the date-time ISO 8601 format should be used in our case (YYYY-MM-DDTHH:MM:SS), e.g.: "If-Unmodified-Since": "2022-02-07T16:18:33"

Responses
204

Updated

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