Authorization Tokens5

Connects2

deposits2

disbursements10

donations2

Donor Accounts6

Donor Advised Funds2

Event Subscriptions4

Events2

files5

financial_accounts3

Giving Pools2

Grant Requests4

Grants5

inboundTransfers6

lockboxes2

mailbox2

mailItems2

nonprofitAddresses1

nonprofitContacts1

Organizations3

paymentSources2

Programs2

properties4

recurring_grants3

unintegrated_grants2

verificationRequests3

inboundTransfers

Get an Inbound Transfer

Get an inbound transfer by its unique identifier.

get/v1/inbound_transfers/{id}

Path parameters

idstring required

The unique identifier for the inbound transfer

Response

The inbound transfer was retrieved

idstring required

The unique identifier for the inbound transfer

program_idstring required

The unique identifier for the program that the inbound transfer belongs to.

amountinteger required

The amount of the inbound transfer in minor currency units (cents). This amount must be positive.

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

status'pending' | 'completed' | 'canceled' | 'failed'

The status of the inbound transfer. An Inbound Transfer is pending if it created and the funds haven't been received yet. The status changes to completed when the funds have been received and the balance of the financial account has been updated. The status changes to canceled if the transfer is canceled. The status changes to failed if the transfer fails.

created_atstring date-time required

The date and time the inbound transfer was created

updated_atstring date-time

The date and time the inbound transfer was last updated

Example response

{
  "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",
    "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"
    },
    "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

Changed in 2 of the 43 revisions of this API.2027

Sep 2, 20265adde36601ba2See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
Jun 25, 202690671617b8252025See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history