Execute a payment attempt for a specific account

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
  • 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:
    • VALID
    • INVALID
    • PENDING
    • AUTHORIZED
  • Defaults to: VALID
  • Description: The new status which you would like to set for the line item.

• effective_at

  • Type: date-time
  • Description: 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

  • Type: string | null
  • Enum:
    • PRINCIPAL_PREPAYMENT_INSTALLMENT_END_TO_START
    • INTEREST
    • DEFERRED_INTEREST
    • PRINCIPAL
    • FEE
    • null
  • Description: Optional designation for which balance bucket the payment should be allocated to.

• 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. Note: this payment will pay down all Line Items which have a root_id equal to this value, meaning e.g., installment interest and amortized fees related to a loan will be paid down by referencing the Loan's Line Item ID.

• external_fields

  • Type: array|null | object|null

Response Codes

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

Example Request in cURL

curl --request POST \
     --url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts//line_items/payments/payment_transfer \
     --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/payment_transfer