CHchariot-giving
inboundTransfers

List Inbound Transfers

Changed on

List inbound transfers for your account.

get/v1/inbound_transfers

Request

  • Base URL
    https://sandboxapi.givechariot.com
  • URL
    https://sandboxapi.givechariot.com/v1/inbound_transfers
  • Auth
    HTTP bearer

Query parameters

page_limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstring

The cursor to use for pagination. If not set, the first page of results will be returned.

program_idstring

Filter the inbound transfers to a single program.

Response

The response for InboundTransfers.list

next_page_tokenstring

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 page_token). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

{
  "results": [
    {
      "id": "inbound_transfer_01j8rs605a4gctmbm58d87mvsj",
      "program_id": "program_01j8rs605a4gctmbm58d87mvsj",
      "amount": 10000,
      "description": "InboundTransfer from my bank account",
      "status": "pending",
      "transfer": {
        "amount": 10000,
        "currency": "USD",
        "financial_account_id": "fa_01j8rs605a4gctmbm58d87mvsj",
        "description": "Disbursement to nonprofit",
        "bank_created_at": "2020-01-31T23:59:59Z",
        "inbound_account_transfer": {
          "created_at": "2020-01-31T23:00:00Z"
        },
        "inbound_ach_transfer": {
          "standard_entry_class_code": "WEB",
          "company_entry_description": "GRANTPMT",
          "originator_routing_number": "1234567890",
          "originator_company_name": "Charity Good",
          "trace_number": "1234567890",
          "effective_date": "2020-01-31T00:00:00Z",
          "status": "accepted",
          "company_discretionary_data": "GRANT-2024-001",
          "payment_related_info": "Grant 12345 for the Annual Fund"
        },
        "ach_transfer": {
          "transfer_id": "ach_transfer_01j8rs605a4gctmbm58d87mvsj",
          "amount": 10000,
          "status": "initiated",
          "direction": "credit",
          "standard_entry_class_code": "corporate_credit_or_debit",
          "company_entry_description": "Disbursement to nonprofit",
          "trace_number": "012345678901234",
          "effective_date": "2020-01-31T00:00:00Z",
          "submitted_at": "2020-01-31T23:00:00Z",
          "settled_at": "2020-07-12 15:00:00.000",
          "rejected_at": "2020-07-12 15:00:00.000",
          "returned_at": "2020-07-12 15:00:00.000",
          "created_at": "2020-01-31T23:00:00Z",
          "updated_at": "2020-01-31T23:00:00Z"
        },
        "check_deposit": {
          "auxiliary_on_us": "102",
          "routing_number": "101050001",
          "submitted_at": "2020-01-31T23:00:00Z",
          "status": "deposited"
        },
        "inbound_real_time_payments_transfer": {
          "status": "confirmed",
          "debtor_name": "Charity Good",
          "debtor_routing_number": "1234567890",
          "debtor_account_number": "9876543210",
          "transaction_identification": "20240101ABC123",
          "remittance_information": "Grant payment",
          "confirmed_at": "2020-01-31T23:00:00Z"
        },
        "inbound_wire_transfer": {
          "status": "confirmed",
          "originator_name": "Charity Good",
          "originator_routing_number": "1234567890",
          "originator_account_number": "9876543210",
          "confirmed_at": "2020-01-31T23:00:00Z"
        }
      },
      "created_at": "2020-01-31T23:00:00Z",
      "updated_at": "2020-01-31T23:00:00Z"
    }
  ]
}

Changes

  • 2026-10-01f4ff1656e498Revision changes
    • info

      added the optional property //////////// to the response with the status