> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rightfoot.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a Borrower's Charge Order

> See which rails a borrower is collected on, in what order, and where that order comes from

# Get a Borrower's Charge Order

Returns the charge order and fallback rules in effect for one borrower, and the instruments Rightfoot can debit.

`charge_order_source` tells you where the order comes from:

| Source | Meaning |
| - | - |
| `borrower` | The borrower's own order, set on first enrollment or with [Change a Borrower's Charge Order](https://docs.rightfoot.com/api-reference/payments/update-charge-settings.md) |
| `lender` | Your [collection policy](https://docs.rightfoot.com/api-reference/payments/get-payment-policy.md) |
| `default` | Neither is set: ACH alone |

`borrower_settings` shows what the borrower has set. A `null` field there follows your policy.

An instrument is `stopped` after a failure that rules it out, such as an expired card or a closed account. A stopped rail is skipped until you send a different card or bank account.


## OpenAPI

````yaml GET /v1/payment_enrollments/{authorizer_unique_id}/charge_settings
openapi: 3.1.0
info:
  title: Rightfoot API
  description: >-
    Submit a batch of authorizers for balance checks, retrieve processed
    balances, and check the status of a batch.
  version: 0.3.0-alpha
servers:
  - url: https://api.rightfoot.com
security:
  - BearerAuth: []
tags:
  - name: General Availability
    description: |
      **General Availability** indicates that the endpoint is production-ready.
  - name: In Development
    description: >
      **In Development** indicates that the endpoint is currently being built
      and will be available in an upcoming release.
paths:
  /v1/payment_enrollments/{authorizer_unique_id}/charge_settings:
    parameters:
      - in: path
        name: authorizer_unique_id
        required: true
        schema:
          type: string
        description: The borrower, as the identifier you enrolled them with.
    get:
      tags:
        - In Development
      summary: Get a borrower's charge order
      description: >
        The charge order and fallback rules in effect for one borrower, where
        they

        come from, and the instruments Rightfoot can debit.


        `charge_order_source` is `borrower` when the borrower has their own
        order,

        `lender` when it comes from your

        [collection policy](/api-reference/payments/get-payment-policy), and

        `default` (ACH alone) otherwise. `borrower_settings` shows what the
        borrower

        has set; a `null` field there follows your policy.
      operationId: get_charge_settings
      responses:
        '200':
          description: The charge settings in effect.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeSettingsResponse'
              example:
                authorizer_unique_id: 5e6f7g8h
                charge_order:
                  - card
                  - ach
                charge_order_source: borrower
                fallback_on:
                  - insufficient_funds
                  - instrument_invalid
                  - authorization_revoked
                  - declined_by_processor
                borrower_settings:
                  charge_order:
                    - card
                    - ach
                  fallback_on: null
                instruments:
                  - rail: ach
                    last4: '3210'
                    status: active
                    stop_reason: null
                  - rail: card
                    last4: '4412'
                    status: active
                    stop_reason: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: You have not enrolled this borrower.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                status: error
                status_code: 404
                error:
                  code: NOT_FOUND
                  message: No enrollment for this borrower
                  timestamp: '2026-11-13T12:00:00Z'
components:
  schemas:
    ChargeSettingsResponse:
      type: object
      description: The charge settings in effect for one borrower.
      properties:
        authorizer_unique_id:
          type: string
        charge_order:
          type: array
          items:
            $ref: '#/components/schemas/ChargeRail'
          description: The order in effect.
        charge_order_source:
          type: string
          enum:
            - borrower
            - lender
            - default
          description: |
            `borrower` — the borrower's own order. `lender` — your collection
            policy's. `default` — neither is set: ACH alone.
        fallback_on:
          type: array
          items:
            $ref: '#/components/schemas/FailureCategory'
          description: The failures that move a payment to the next rail, in effect.
        borrower_settings:
          type: object
          description: What the borrower has set. A `null` field follows your policy.
          properties:
            charge_order:
              type:
                - array
                - 'null'
              items:
                $ref: '#/components/schemas/ChargeRail'
            fallback_on:
              type:
                - array
                - 'null'
              items:
                $ref: '#/components/schemas/FailureCategory'
        instruments:
          type: array
          description: >
            The bank account Rightfoot would debit, and the borrower's debit
            card if

            you sent one.
          items:
            type: object
            properties:
              rail:
                $ref: '#/components/schemas/ChargeRail'
              last4:
                type:
                  - string
                  - 'null'
                description: Last four of the card or bank account, if known.
              status:
                type: string
                enum:
                  - active
                  - stopped
                description: >
                  `stopped` after a failure that rules the instrument out (an

                  expired card, a closed account, a revoked authorization). A
                  stopped

                  rail is skipped.
              stop_reason:
                type:
                  - string
                  - 'null'
                enum:
                  - null
                  - instrument_invalid
                  - authorization_revoked
                description: Why it stopped. `null` while active.
    ApiErrorResponse:
      type: object
      properties:
        status:
          type: string
          description: Status of the error, either "error" or "success"
        status_code:
          type: integer
          description: HTTP status code of the error
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code (e.g., "RESOURCE_NOT_FOUND")
            message:
              type: string
              description: Detailed error message.
            details:
              type: string
              description: Additional details about the error
            timestamp:
              type: string
              format: date-time
              description: Time the error occurred
            suggestion:
              type: string
              description: Suggested action to resolve the error
        documentation_url:
          type: string
          format: uri
          description: URL to the documentation for the error
    ChargeRail:
      type: string
      enum:
        - ach
        - card
      description: |
        `ach` — the bank account in `account_number` / `routing_number`.

        `card` — the debit card in `charge_instrument`.
    FailureCategory:
      type: string
      enum:
        - insufficient_funds
        - instrument_invalid
        - authorization_revoked
        - declined_by_processor
      description: >
        `insufficient_funds` — not enough money on the rail tried.


        `instrument_invalid` — the instrument cannot take a payment: a closed or

        frozen account, an expired card.


        `authorization_revoked` — the borrower or their bank refused the
        payment,

        such as an unauthorized ACH return or a card dispute.


        `declined_by_processor` — the payment processor refused it for its own

        reasons.


        A processor outage (`processor_error`) never moves a payment to another

        rail: the same rail is tried again later. It cannot be listed.
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
          example:
            status: error
            status_code: 401
            error:
              code: UNAUTHORIZED
              message: Invalid API key provided.
              timestamp: '2024-09-16T12:01:00Z'
              suggestion: Please check your API key.
            documentation_url: https://api.rightfoot.com/docs
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Authentication to the API is performed via Bearer Token Authentication.
        Provide your API key as the bearer token in the Authorization header.


        All API requests must be made over HTTPS. Calls made over plain HTTP
        will fail. API requests without authentication will also fail.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.