--- title: "List disbursements" method: GET path: "/v1/disbursements" tags: ["disbursements"] --- # List disbursements `GET /v1/disbursements` Returns a list of disbursements. ## Query parameters - `organization_id` string - `program_id` string - `page_limit` integer - `next_page_token` string - `includes` string ## Response `200` The response for Disbursements.list - object - `results` Disbursement[] - `id` string, required — The unique identifier for the disbursement - `organization_id` string, required — The unique identifier for the organization that will receive the payment - `organization` Organization — An `Organization` represents an operating nonprofit or an operating sub-organization of a parent or sponsoring nonprofit. The generally accepted identifier for an organization is its domain. This domain provides proof of identity, ownership and relationship to an entity. Organizations can receive payments from payers on the network. - `id` string, required — The unique identifier for the object. - `ein` string, required — The EIN of the organization. - `name` string, required — The name of the organization. For organizations that operate under a different name than the one tied to the legal entity, this name will differ from the name of the linked entity. This is also known as the "DBA" or "Doing Business As" name of the organization. - `parent_organization_id` string — The unique identifier of the parent organization, if this is a sponsored organization. This value is `null` or empty if the organization is not sponsored or not a child of a parent organization. - `physical_address` Address - `city` string — City, district, suburb, town, or village. Maximum length: 255 characters. - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Maximum length: 255 characters. - `line1` string — Address line 1 (e.g. street, PO Box, or company name). Maximum length: 255 characters. - `line2` string — Address line 2 (e.g. apartment, suite, unit, or building). Maximum length: 255 characters. - `postal_code` string — ZIP or postal code. Maximum length: 40 characters. - `state` string — State, county, province, or region. Maximum length: 255 characters. - `classification` NonprofitClassification — A classification of the nonprofit entity as defined by the IRS. - `group_exemption_number` string — This is a four-digit internal IRS number assigned to central/parent entity holding group exemption letters. - `subsection_code` TaxExemptCode — A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. - `code` integer, required — The code of the tax exempt code - `name` string, required — The name of the tax exempt code - `description` string — The description of the tax exempt code - `filing_requirement_code` TaxExemptCode — A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. - `code` integer, required — The code of the tax exempt code - `name` string, required — The name of the tax exempt code - `description` string — The description of the tax exempt code - `foundation_code` TaxExemptCode — A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. - `code` integer, required — The code of the tax exempt code - `name` string, required — The name of the tax exempt code - `description` string — The description of the tax exempt code - `affiliation_code` TaxExemptCode — A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. - `code` integer, required — The code of the tax exempt code - `name` string, required — The name of the tax exempt code - `description` string — The description of the tax exempt code - `organization_code` TaxExemptCode — A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. - `code` integer, required — The code of the tax exempt code - `name` string, required — The name of the tax exempt code - `description` string — The description of the tax exempt code - `exempt_status_code` TaxExemptCode — A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. - `code` integer, required — The code of the tax exempt code - `name` string, required — The name of the tax exempt code - `description` string — The description of the tax exempt code - `deductibility_code` TaxExemptCode — A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. - `code` integer, required — The code of the tax exempt code - `name` string, required — The name of the tax exempt code - `description` string — The description of the tax exempt code - `ntee_code` NteeCode — A code that is used to classify the nonprofit entity as defined by the IRS. - `code` string, required — The code of the NTEE code - `description` string, required — The description of the NTEE code - `parent_code` string — The parent code of the NTEE code - `parent_description` string — The description of the parent NTEE code - `naics_code` NaicsCode — A code that is used to classify the nonprofit entity as defined by the NAICS. - `naics2` string — The code of the NAICS code - `naics2_description` string — The description of the NAICS code - `naics4` string — The code of the NAICS code - `naics4_description` string — The description of the NAICS code - `naics6` string — The code of the NAICS code - `naics6_description` string — The description of the NAICS code - `compliance` NonprofitCompliance — An object that contains legal information about the nonprofit entity and its tax-exemption status. This information is used to comply with regulations and ensure the legitimacy of the nonprofit for purposes of donations and disbursements. - `daf_eligible` boolean — Whether the entity is eligible to receive donations from a Donor Advised Fund - `irs_pub_78` ComplianceRequirement — A compliance requirement is a requirement that a nonprofit entity must meet in order to be eligible for Chariot services. - `compliant` boolean — Whether the entity is compliant with the requirement - `reason` string — The reason for the compliance requirement - `last_found_at` string, date-time — The date and time when the compliance requirement was last found - `ofac` ComplianceRequirement — A compliance requirement is a requirement that a nonprofit entity must meet in order to be eligible for Chariot services. - `compliant` boolean — Whether the entity is compliant with the requirement - `reason` string — The reason for the compliance requirement - `last_found_at` string, date-time — The date and time when the compliance requirement was last found - `foundation_code` ComplianceRequirement — A compliance requirement is a requirement that a nonprofit entity must meet in order to be eligible for Chariot services. - `compliant` boolean — Whether the entity is compliant with the requirement - `reason` string — The reason for the compliance requirement - `last_found_at` string, date-time — The date and time when the compliance requirement was last found - `california_attorney_general_registry` ComplianceRequirement — A compliance requirement is a requirement that a nonprofit entity must meet in order to be eligible for Chariot services. - `compliant` boolean — Whether the entity is compliant with the requirement - `reason` string — The reason for the compliance requirement - `last_found_at` string, date-time — The date and time when the compliance requirement was last found - `california_franchise_tax_board` ComplianceRequirement — A compliance requirement is a requirement that a nonprofit entity must meet in order to be eligible for Chariot services. - `compliant` boolean — Whether the entity is compliant with the requirement - `reason` string — The reason for the compliance requirement - `last_found_at` string, date-time — The date and time when the compliance requirement was last found - `mission_statement` string — The mission statement of the organization - `web` WebDomain — A web domain is a unique identifier for a website or web application that is associated with an organization. Domains are important identity constructs that underpin the web and online interactions. The domain can be used as an identifier and its validity can be asserted via DNS. - `domain` string, required — The DNS domain name - `brand` Brand — Fair use brand assets that are associated with an organization and can be used for identification and informational purposes. - `icon_url` string — The URL of the organization's icon - `logo_url` string — The URL of the organization's logo - `officers` Person[] — The list of officers of the organization - `name` string, required — The full name of the person - `title` string — The title or role of the person with respect to the nonprofit entity - `claimed` boolean — A flag to indicate if the nonprofit has been claimed by a user. A nonprofit is claimed if a user signs up for a Chariot account with this nonprofit and is verified by the Chariot team. - `program_id` string, required — The identifier for the program that the disbursement is associated with - `amount` integer, required — The payment amount in USD cents. Must be a positive amount. - `auto_fund` boolean — Whether just-in-time (JIT) funding is enabled for this disbursement. When true, Chariot automatically creates an inbound transfer for the disbursement amount when it is approved. - `created_at` string, date-time — The date and time the disbursement was created - `updated_at` string, date-time — The date and time the disbursement was last updated - `status` 'pending_approval' | 'canceled' | 'awaiting_verification' | 'rejected' | 'validating_organization' | 'awaiting_account_claim' | 'awaiting_balance' | 'submitted' | 'stopped' | 'completed' | 'failed' — The lifecycle status of the disbursement. Possible values include: - `pending_approval`: The disbursement is awaiting approval from the grantmaker - `canceled`: The disbursement was canceled by the grantmaker - `awaiting_verification`: The disbursement is awaiting verification from Chariot - `rejected`: The disbursement was rejected by Chariot before being submitted - `validating_organization`: Validating recipient organization's payment and contact information before submission. - `awaiting_account_claim`: The disbursement is awaiting account claim by the nonprofit or check delay expiration - `awaiting_balance`: The disbursement is awaiting sufficient grantmaker balance - `submitted`: The disbursement payment has been submitted to the payment network and is being processed - `stopped`: The disbursement payment was stopped after it was submitted - `completed`: The disbursement payment has been completed and funds have been received by the receiving organization - `failed`: The disbursement payment failed or the receiving organization did not receive the payment To see a description of each status, see the "Disbursement Lifecycle" section of the Chariot documentation. - `cancelation` DisbursementCancelation — If your account requires approvals for disbursements and the disbursement was not approved, this will contain the details of the cancelation. - `canceled_by` string — If the disbursement was canceled by a user in the dashboard, the email address of that user. - `canceled_at` string, date-time — The RFC 3339 date and time at which the Disbursement was canceled. - `approval` DisbursementApproval — If your account requires approvals for disbursements and the disbursement was approved, this will contain the details of the approval. - `approved_by` string — If the disbursement was approved by a user in the dashboard, the email address of that user. - `approved_at` string, date-time — The RFC 3339 date and time at which the Disbursement was approved. - `rejection` DisbursementRejection — If the disbursement was rejected by Chariot, this will contain details as to why the disbursement was rejected. - `reason` 'insufficient_funds' | 'incorrect_recipient' | 'suspected_fraud' | 'requested_by_user' | 'acceptance_criteria_failed' | 'duplicate' | 'unknown' — Why the disbursement was rejected. Possible values include: - `insufficient_funds`: The disbursement was rejected because the grantmaker does not have enough funds in their account. - `incorrect_recipient`: The disbursement was rejected because the recipient or address was incorrect. - `suspected_fraud`: The disbursement was suspected to be fraudulent. - `requested_by_user`: The disbursement was rejected at the request of the grantmaker. - `acceptance_criteria_failed`: The disbursement was rejected because the disbursement did not meet the acceptance criteria for the receiving organization. - `duplicate`: The disbursement was rejected because the disbursement was a duplicate. - `unknown`: The disbursement was rejected for an unknown reason. - `rejected_at` string, date-time — The RFC 3339 date and time at which the Disbursement was rejected. - `transfers` DisbursementTransfer[] — The list of transfers for the disbursement. This can have multiple items if the disbursement's underlying payment was retried multiple times. For example, if a check was returned or stopped and the disbursement was retried as an ACH transfer. If the disbursement was not retried, this will have a single item. - `account_transfer` AccountTransfer — An account transfer represents an instant, electronic transfer of funds. - `id` string, required — The unique identifier for the account transfer - `amount` integer, required — The amount of the account transfer in minor currency units (cents) - `created_at` string, date-time, required — The date and time the account transfer was created - `ach_transfer` AchTransfer — An ACH transfer represents an electronic transfer of funds via the Automated Clearing House (ACH) payment network. - `id` string, required — The unique identifier for the ACH transfer - `amount` integer, required — The amount of the ACH transfer in minor currency units (cents). For ACH debits, this is a negative number. - `status` 'initiated' | 'submitted' | 'completed' | 'rejected' | 'returned', required — The lifecycle status of the ACH transfer. Possible values include: - `initiated`: The ACH transfer has been initiated and is pending submission to the Federal Reserve. - `submitted`: The ACH transfer has been submitted to the Federal Reserve. - `completed`: The ACH transfer has been completed. Funds should be settled. - `rejected`: The ACH transfer was rejected. - `returned`: The ACH transfer was returned by the receiving organization. - `company_entry_description` string — The company entry description for the ACH transfer. This is included in the transfer data sent to the receiving bank. - `trace_number` string — A 15 digit number recorded in the Nacha file and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at the receiving bank. ACH trace numbers are not unique, but are used to correlate returns. - `effective_date` string, date-time — The ACH transfer's effective date as sent to the Federal Reserve. This is the date the funds will be available to the receiving organization. - `submitted_at` string, date-time — The date and time the ACH transfer was submitted to the Federal Reserve. - `settled_at` string, date-time — The date and time at which the ACH transfer was settled. If the transfer is not settled, this will be null. - `rejected_at` string, date-time — The date and time at which the ACH transfer was rejected. If the transfer is not rejected, this will be null. - `returned_at` string, date-time — The date and time at which the ACH transfer was returned. If the transfer is not returned, this will be null. - `created_at` string, date-time, required — The date and time the ACH transfer was created - `updated_at` string, date-time — The date and time the ACH transfer was last updated - `check_transfer` CheckTransfer — A check transfer represents a paper check that is mailed to the receiving organization. - `id` string, required — The unique identifier for the check transfer - `amount` integer, required — The amount of the check transfer in minor currency units (cents) - `status` 'pending' | 'canceled' | 'issued' | 'rejected' | 'deposited' | 'stopped' | 'returned', required — The lifecycle status of the check. The set of statuses include: - `pending`: The check is pending review by Chariot. - `canceled`: The check has been canceled. - `issued`: The check has been mailed and is pending delivery. - `rejected`: The check was rejected by Chariot. - `deposited`: The check has been deposited by the receiving organization. - `stopped`: A stop payment was requested on the check. - `returned`: The check has been returned by the receiving organization. To see a more detailed description of each status and the overall lifecycle of check disbursements, see the "Transfer Statuses" section of the Chariot documentation. - `memo` string, required — The memo on the check. Maximum of 72 characters. - `check_number` string — The check number - `recipient_name` string — The name that will be printed on the check. - `mailing_address` PostalAddress, required — A postal address is a mailing address where physical mail can be received. Postal addresses can be used to receive paper checks. - `city` string, required — City, district, suburb, town, or village. - `country` string, required — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `line1` string, required — Address line 1 (e.g. street, PO Box, or company name) - `line2` string — Address line 2 (e.g. apartment, suite, unit, or building) - `postal_code` string, required — ZIP or postal code - `state` string, required — State, county, province, or region - `tracking_updates` TrackingUpdate[] — The list of tracking updates for the check - `category` 'in_transit' | 'processed_for_delivery' | 'delivered' | 'returned_to_sender', required — The category of the tracking update. The set of categories include: - `in_transit`: The check has been processed by the origin facility. - `processed_for_delivery`: The check has been greenlit for delivery at the recipient's nearest postal facility. The check should reach the mailbox within 1-2 business days of this tracking update. - `delivered`: The check has been delivered to the recipient's address. - `returned_to_sender`: The check has been returned to the sender due to barcode, ID tag area, or address errors. - `created_at` string, date-time, required — The date and time the tracking update was created - `submitted_at` string, date-time — The date and time the check was submitted to the carrier. - `canceled_at` string, date-time — The date and time the check was canceled. - `stopped_at` string, date-time — The date and time the check was stopped. - `deposited_at` string, date-time — The date and time the check was deposited. - `created_at` string, date-time, required — The date and time the check transfer was created - `updated_at` string, date-time — The date and time the check transfer was last updated - `transactions` Transaction[] — The list of transactions for the disbursement - `id` string — The unique identifier for the transaction - `amount` integer, required — The gross transaction amount in minor currency units (cents) before any fees are deducted. This represents the total amount of the donation. - `fee_amount` integer, nullable — The fee amount in minor currency units (cents) to be deducted from the transaction amount. This is an optional field. If not provided, no fee will be deducted. The fee amount must be less than the transaction amount. - `net_amount` integer, required — The net transaction amount in minor currency units (cents) after fees are deducted. This is calculated as: net_amount = amount - fee_amount. This is the actual amount that will be disbursed to the nonprofit. - `description` string — A description of the transaction. This description is displayed to the receiving organization. - `type` 'donor_advised_fund_grant', required — The type of donation - `donor_advised_fund_grant` DonorAdvisedFundGrant — A donor-advised fund grant is a charitable donation made by a donor-advised fund (DAF) on behalf of the donor. - `grant_id` string — A unique identifier for the grant within the DAF provider's internal system. Maximum length: 255 characters. - `organization_name` string — The name of the DAF organization that made the grant. Maximum length: 255 characters. - `fund_name` string — The name of the DAF fund that made the grant. Maximum length: 255 characters. - `purpose` string — The purpose of the grant. Maximum length: 400 characters. - `note` string — A note about the grant. Maximum length: 400 characters. - `donors` Donor[] — The list of donors for the transaction - `first_name` string — The first name of the donor. Maximum length: 255 characters. - `last_name` string — The last name of the donor. Maximum length: 255 characters. - `email` string — The email address of the donor. Maximum length: 255 characters. - `phone` string — The phone number of the donor. Maximum length: 20 characters. - `address` Address - `city` string — City, district, suburb, town, or village. Maximum length: 255 characters. - `country` string — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Maximum length: 255 characters. - `line1` string — Address line 1 (e.g. street, PO Box, or company name). Maximum length: 255 characters. - `line2` string — Address line 2 (e.g. apartment, suite, unit, or building). Maximum length: 255 characters. - `postal_code` string — ZIP or postal code. Maximum length: 40 characters. - `state` string — State, county, province, or region. Maximum length: 255 characters. - `created_at` string, date-time — The date and time the transaction was created - `updated_at` string, date-time — The date and time the transaction was last updated - `metadata` object — Additional metadata for the transaction - `next_page_token` string — A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. ## Other responses - `400` — The request is invalid or contains invalid parameters - `401` — Unauthorized. The request is missing the security (OAuth2 Bearer token) requirements and the server is unable to verify the identify of the caller. - `403` — Access denied - `500` — Internal Server Error --- [API](https://skmtc.net/chariot-giving/apis/chariot-api-4.md) · [All operations](https://skmtc.net/chariot-giving/apis/chariot-api-4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chariot-giving/chariot-api-4/versions/c194d399d515/schema)