API ReferenceRepayments

Create Card Payment

Pays down the outstanding balance of a payment card. The repayment is settled synchronously against the card’s loan application and returns status: posted on success. Autopay must be disabled on the card unless your partner configuration settles from a partner FBO account. Omit account_id to debit the DDA account attached to the card.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

payment_card_idstringRequiredformat: "uuid"
External ID of the payment card being paid down.

Request

This endpoint expects an object.
amountdoubleRequired>=0.01
Repayment amount in USD. Must be at least 0.01 and no greater than the card's current outstanding balance. Limited to 2 decimal places and 10 total digits.
railenumOptionalDefaults to book_transfer

Settlement rail. Defaults to book_transfer, the only rail currently implemented. ach and instant are reserved for future use — sending either records the repayment with status: error and returns a 400 payment_error.

account_idstringOptionalformat: "uuid"
External ID of the account to debit. Must be active and owned by the cardholder. When omitted, the DDA account attached to the card is used, which must itself be active.

Response

Repayment created and settled
idstringformat: "uuid"
Unique identifier for this repayment. Use it to retrieve the repayment later.
amountstringformat: "decimal"
Repayment amount in USD, returned as a decimal string with 2 decimal places.
railenum
Settlement rail used for this repayment.
account_idstringformat: "uuid"
External ID of the account that was debited.
statusenum

Always posted on a 201 response — the repayment is settled before the response is returned. Attempts that fail to settle return an error status code instead.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error