ROOKDocs
Sign In
PATCH

Update credit configuration

ENDPOINT/v1/wallets/{wallet_id}/credit-configuration

Applies a partial update to wallet credit terms. Omitted fields are left unchanged. Sending minimum_payment_rule replaces that object. Sending autopay merges with the stored object. Updating credit_limit also updates Wallet.credit_limit.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.
Content-TypestringREQUIREDMust be application/json.
Idempotency-KeystringOPTIONALUnique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

ParameterTypeRequirementDescription
wallet_idstringREQUIREDUnique identifier of the wallet.

Request Body Schema

application/json
credit_limitobject
optional

Maximum credit extended to this wallet. `amount` is a non-negative integer of minor units.

Properties of credit_limit
amountanyrequired
currencystringrequired
ISO 4217 alphabetic currency code.
purchase_aprinteger
optional

Annual percentage rate in basis points. One basis point is 0.01 percent. `2499` is 24.99% APR.

cash_advance_aprinteger
optional

APR in basis points applied to cash advances. `2999` is 29.99%.

penalty_aprinteger
optional

APR in basis points applied after a penalty trigger such as a missed payment. `2999` is 29.99%.

billing_cycle_dayinteger
optional

Day of the month on which the billing cycle closes. Capped at 28 so every month has that day. Evaluated in the program's `timezone`.

payment_due_dayinteger
optional

Day of the month on which the statement minimum payment is due. Capped at 28 so every month has that day. Evaluated in the program's `timezone`.

minimum_payment_ruleobject
optional

How the statement minimum payment is calculated. `PERCENT_OF_BALANCE` uses `percent_bps` of the statement balance. `FIXED_AMOUNT` uses `floor_amount`. `GREATER_OF_PERCENT_OR_FIXED` uses the larger of the two.

Properties of minimum_payment_rule
typestringrequired
Calculation method for the statement minimum payment.
percent_bpsintegerrequired
Percentage of statement balance in basis points. `200` is 2.00%. Ignored when `type` is `FIXED_AMOUNT`.
floor_amountobjectrequired
Dollar floor (and the amount used when `type` is `FIXED_AMOUNT`). `amount` is a non-negative integer of minor units; `2500` with `USD` is $25.00.
grace_period_daysinteger
optional

Number of days after `payment_due_date` during which a payment in full avoids purchase interest. `0` means interest accrues with no grace.

autopayobject
optional

Partial update for autopay settings. Omitted keys are left unchanged. Sending `enabled` as false stops origination on the next due date.

Properties of autopay
enabledboolean
Whether a payment is originated automatically on each due date.
amount_typestring
Amount pulled on each payment due date when autopay is enabled. `MINIMUM` pays `minimum_payment_due`. `STATEMENT_BALANCE` pays `last_statement_balance`. `FIXED_AMOUNT` pays `fixed_amount`.
fixed_amountobject
Amount originated when `amount_type` is `FIXED_AMOUNT`. `amount` is a non-negative integer of minor units.
funding_financial_account_idstring
Financial account debited for autopay.

Response Codes & Schemas

200Credit terms after the update.
application/json
{
  "object": "wallet_credit_configuration",
  "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
  "credit_limit": {
    "amount": 750000,
    "currency": "USD"
  },
  "purchase_apr": 2499,
  "cash_advance_apr": 2999,
  "penalty_apr": 2999,
  "billing_cycle_day": 15,
  "payment_due_day": 10,
  "minimum_payment_rule": {
    "type": "GREATER_OF_PERCENT_OR_FIXED",
    "percent_bps": 200,
    "floor_amount": {
      "amount": 2500,
      "currency": "USD"
    }
  },
  "grace_period_days": 25,
  "autopay": {
    "enabled": true,
    "amount_type": "MINIMUM",
    "fixed_amount": null,
    "funding_financial_account_id": "5f6a8b21-3c47-4e90-bd12-7a4e8c1f3056"
  },
  "updated_at": "2026-08-27T16:20:00Z"
}
400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}
401Unauthorized: missing, malformed, or unknown API key.
application/json
{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}
403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.
application/json
{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}
404Not Found: unknown id, or the resource is not visible to this API key.
application/json
{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}
409Conflict: incompatible state, or Idempotency-Key reused with a different body.
application/json
{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}
422Unprocessable Entity: the document is valid JSON but violates a business rule.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_funds",
    "message": "The source financial account does not have enough available balance.",
    "param": "amount",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/insufficient_funds"
  }
}
429Too Many Requests: the API key exceeded its rate limit.
application/json
{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}
500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}