API Reference

Update a purse

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

Allows update to parts of a purse. The balance can never be updated in this manner.

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
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.

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

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