AFaffirm
Cards API

Progress

Retrieve the customer’s data from their existing loan and determine how much they've paid towards the loan so far.

get/cards/{checkout_id}/progress

Request

  • Base URL
    https://api.global.affirm.com/api/v2
  • URL
    https://api.global.affirm.com/api/v2/cards/{checkout_id}/progress
  • Auth
    HTTP basic

Path parameters

checkout_idstring required

The id of the charge.

Response

HTTP 200 OK

loan_idstring

A unique identifier for the loan.

total_loan_valueinteger

The total value of the loan.

down_paymentinteger

The amount of the down payment.

paid_principalinteger

The amount of the principal paid on the loan.

paid_interestinteger

The amount of the interest paid on the loan.

Example response

{
  "loan_id": "ALE5-YGRS",
  "total_loan_value": 75000,
  "down_payment": 10000,
  "paid_principal": 5000,
  "paid_interest": 2500
}

Changes

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