URL Expired

The URL for this request expired after 30 days.

account_id

• Type: string
• Required: Yes
• Description: ID of the Account

Body of request to create payment.

line_item_id

• Type: string
• Required: Yes
• Pattern: ^(?!can_).*$
• Description: The ID to be associated with the line item for future requests.

original_amount_cents

• Type: integer
• Required: Yes
• Defaults to: 0
• Description: The payment amount in cents.

line_item_status

• Type: string
• Enum: Yes
• Defaults to: VALID
• Description: The new status which you would like to set for the line item.

Allowed: VALID, INVALID, PENDING, AUTHORIZED

effective_at

• Type: date-time
• Description: The Date-Time that the payment is applicable to the account. This field should not be used for back-dating payments in VALID status, but may be used to back-date payments in other statuses (e.g. PENDING). Valid payment records should be back-dated only for testing or if a data migration is being performed with migration_mode enabled.

allocation

• Type: string or null (enum)
• Description: Optional designation for which balance bucket the payment should be allocated to. PRINCIPAL_PREPAYMENT_INSTALLMENT_END_TO_START allocation type is used to signal intent, and is not a guarantee that the payment will pour directly into principal.

Allowed: INTEREST, DEFERRED_INTEREST, PRINCIPAL, FEE, PRINCIPAL_PREPAYMENT_INSTALLMENT_END_TO_START, null

allocation_line_item_id

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

payment_intent

• Type: string (enum)
• Description: Optional designation for the intended purpose of the payment. A designation of LOAN_PAYOFF will trigger an early interest accrual of the corresponding loan allocation.

Allowed: LOAN_PAYOFF

external_fields

• Type: array or object (nullable)

Preview

• Type: boolean
• Description: Flag to decide if this is a preview

Allowed values: true, false

HTTP Response Codes

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

Code Example

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts//line_items/payments/payment_record \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "original_amount_cents": 0,
  "line_item_status": "VALID"
}
'

Click Try It! to start a request and see the response!