API Reference

Create Payment

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

Create new payment. Permission: Create Payments

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

Payment amount in cents.

string
Defaults to null

Free-text description or notes.

string
Defaults to null

Additional detail information.

string
Defaults to null

External system identifier for cross-referencing.

date
Defaults to null

string date/time

string
Defaults to null

Human-readable failure reason.

string
Defaults to null

Source system the record was imported from.

boolean
Defaults to false

Whether this is a prenote (verification) transaction.

boolean
Defaults to false

Whether this is a promise-to-pay.

string
required

UUID of the associated loan.

string
enum
required

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

Allowed:
date
required

string date/time

date
required

string date/time

int32
Defaults to null

External reference ID.

string
Defaults to null

string date/time

string
Defaults to null

Return reason code.

string
Defaults to null

Human-readable return reason.

date
Defaults to null

string date

string
enum
required

Current status of the resource.

date
Defaults to null

string date/time

int32
Defaults to 0

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 about 1 month ago

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

Updated about 1 month ago