URL Expired

The URL for this request expired after 30 days.

Request Schema

account_id
string
required
ID of the Account

Body of request to create payment.

line_item_id
string
^(?!can_).*$
The ID to be associated with the line item for future requests.

original_amount_cents
integer
required
Defaults to 0
The payment amount in cents.

line_item_status
string
enum
Defaults to VALID
The new status which you would like to set for the line item
Allowed:
VALID, INVALID, PENDING, AUTHORIZED

effective_at
date-time
The Date-Time that the payment is applicable to the account. This field should only be used to back-date payment transactions for the purpose of testing or if a data migration is being performed with migration_mode enabled.

allocation
string | null
enum
Optional designation for which balance bucket the payment should be allocated to. Allowed:
INTEREST, DEFERRED_INTEREST, PRINCIPAL, FEE, PRINCIPAL_PREPAYMENT_INSTALLMENT_END_TO_START, null

allocation_line_item_id
string
If included, this payment will attempt to pay down the referenced Line Item first, prior to any other balances on the account.

external_fields
array, null | object, null

Response Status Codes

• 200 Payment created
• 401 Unauthorized.
• 403 Forbidden.
• 422 Invalid input
• 429 Too many requests.
• default Unexpected Error.

Example CURL Request

curl --request POST \
     --url https://contact/accounts/{account_id}/line_items/payments \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "original_amount_cents": 0,
  "line_item_status": "VALID"
}'

Base URL

https://Contact sales to enable your sandbox/accounts/{account_id}/line_items/payments

Try it Out

Click Try It! to start a request and see the response here!
Or choose an example:

application/json