TRtrueaccord
Payments

Get payment plans for a debt

Lists all payment payment plans for a debt.

get/debts/{debtId}/paymentPlans/

Request

Query parameters

frominteger

Milliseconds since Jan 1st, 1970 UTC.

Display only results created after the from value.

tointeger

Milliseconds since Jan 1st, 1970 UTC.

Display only results created until the to value.

withInactivatedboolean

Flag to include inactivated payment plans in response. Defaults to include them. Cancel by settign value to false.

Response

Returns an array of all active payment plans.

nextInstallmentinteger
fullyPaidboolean
debtStateIdstring
isRecurringboolean

Example response

[
  {
    "application": {
      "originatingTokenId": "6edb055cbcf94dea8abb4f71bfac38f9",
      "installments": [
        {
          "amount": {
            "amount": 30000,
            "currency": "USD"
          }
        }
      ],
      "paymentAmount": {
        "amount": 30000,
        "currency": "USD"
      },
      "numberOfInstallments": 6,
      "frequency": "MONTHLY",
      "consent": {
        "ip": "0:0:0:0:0:0:0:1"
      },
      "debtId": "92101cfb7ef50724ed584d070eac4840",
      "startCalendarDay": {
        "day": 6,
        "month": 4,
        "year": 2012
      },
      "reason": "REQUEST_FOR_SPECIFIC_TERMS",
      "createdByUserAccount": "deadbeefdeadbeefdeadbeefdeadbeef",
      "amountToPay": {
        "amount": 30000,
        "currency": "USD"
      },
      "discount": {
        "amount": 30000,
        "currency": "USD"
      }
    },
    "nextInstallment": 1,
    "paymentMethodInfo": {
      "cardInfo": {
        "expirationMonth": "01",
        "expirationYear": "2022",
        "binNumber": "411111",
        "billingZipCode": "94110",
        "cardType": "VISA",
        "lastFourDigits": "1111"
      }
    },
    "revocation": {
      "reason": "REQUESTED_PLAN_CANCELLATION",
      "revocationReason": "REQUESTED_PLAN_CANCELLATION"
    },
    "installments": [
      {
        "installmentAmount": {
          "amount": 30000,
          "currency": "USD"
        },
        "amountDue": {
          "amount": 30000,
          "currency": "USD"
        },
        "status": "PAID_ON_TIME",
        "isPaid": true
      }
    ],
    "debtStateId": "6fef79e2339d4f9e83ee1eb61d42b634",
    "isRecurring": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.