API Reference

Create a new purse for a member

post
https://trac-demo.stage.pebble.cloud/api/v1/orgs//members//purses
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params

Purses represent a balance of some kind held by a member. Members have multiple purses of different types.

In particular there is one and only one default purse which holds the member's free floating cash balance and the pending purse against which transactions that may require later disbursement by rules are committed.

Other purses are of type credit and are linked to a Credit Profile, representing schemes for the granting of credit under certain conditions.

tags
object

Tags that can be used to categorize the purse.

externalIds
object

External IDs associated with the purse.

string
required

A title for the purse.

string

The current balance of the purse.

date-time

Timestamp from which this purse is valid. Mostly used for credit eligability on credit purses. If this is not set then is is valid from the start of time.

date-time

Timestamp to which this purse is valid. Mostly used for credit eligability on credit purses. If this is not set then is is valid until the end of time.

validSessions
array

List of sessions for which this purse is valid. Mostly used for credit eligibility on credit purses. If this is not set then it is valid for all sessions.

validSessions
credit
object

Data relating to credit transactions and use of credit

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