API Reference

Update Payment

patch
https://{your-totality-url}.com/api/payments/

Update existing payment. Permission: Update Payments

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

UUID of the payment

Body Params
int32

Payment amount in cents.

string

Free-text description or notes.

string

Additional detail information.

string

External system identifier for cross-referencing.

date

string date/time

string

UUID of the failed payment this replaces.

string

Failure reason code.

string

Human-readable failure reason.

int32

Fee portion of the payment in cents.

string

Source system the record was imported from.

int32

Interest portion of the payment in cents.

boolean

Whether this is a prenote (verification) transaction.

boolean

Whether this is a promise-to-pay.

string
enum

Method of payment (Cash, Check, Direct Deposit, Debit Card).

Allowed:
date

string date/time

int32

Principal portion of the payment in cents.

date

string date/time

int32

External reference ID.

string

Return reason code.

string

Human-readable return reason.

string

string date/time

date

string date

string
enum

Current status of the resource.

date

string date/time

int32

Transfer amount in cents.

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Updated 20 days ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 20 days ago