latestOpenAPI 3.1.02026-08-22124199170.4 KB

8a237f1f704f

repayments

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.

post/v2/payment-cards/{payment_card_id}/payments/

Path parameters

payment_card_idstring uuid required

External ID of the payment card being paid down.

Headers

Authorizationstring required

Bearer authentication

Request body

amountnumber double required

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.

rail'book_transfer' | 'ach' | 'instant'

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_idstring 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

idstring uuid required

Unique identifier for this repayment. Use it to retrieve the repayment later.

amountstring decimal required

Repayment amount in USD, returned as a decimal string with 2 decimal places.

rail'book_transfer' | 'ach' | 'instant' required

Settlement rail used for this repayment.

account_idstring uuid required

External ID of the account that was debited.

status'posted' required

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.