Received Credits

ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.

Endpoints

GET/v1/treasury/received_credits/:id

GET/v1/treasury/received_credits

POST/v1/test_helpers/treasury/received_credits

The ReceivedCredit object

Attributes

idstring
Unique identifier for the object.

objectstring
String representing the object’s type. Objects of the same type share the same value.

amountinteger
Amount (in cents) transferred.

createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.

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

failure_codenullable enum

Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.

Possible enum values

account_closed

Funds can’t be sent to a closed FinancialAccount.

account_frozen

Funds can’t be sent to a frozen FinancialAccount.

international_transaction

International transactions can’t be sent to FinancialAccount.

other

Funds can’t be sent to FinancialAccount for other reasons.

financial_accountnullable string
The FinancialAccount that received the funds.

hosted_regulatory_receipt_urlnullable string
A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.

initiating_payment_method_detailsobject
Details about the PaymentMethod used to send a ReceivedCredit.

linked_flowsobject
Other flows linked to a ReceivedCredit.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

networkenum
The rails used to send the funds.
Possible enum values
ach
card
stripe
us_domestic_wire

reversal_detailsnullable object
Details describing when a ReceivedCredit may be reversed.

statusenum
Status of the ReceivedCredit. ReceivedCredits are created either succeeded (approved) or failed (declined). If a ReceivedCredit is declined, the failure reason can be found in the failure_code field.
Possible enum values
failed
The ReceivedCredit was declined, and no Transaction was created.
succeeded
The ReceivedCredit was approved.

transactionnullable stringExpandable
The Transaction associated with this object.

The ReceivedCredit object

{
  "id": "rc_1MtkSr2eZvKYlo2CcysvUbEw",
  "object": "treasury.received_credit",
  "amount": 1000,
  "created": 1680755425,
  "currency": "usd",
  "description": "Stripe Test",
  "failure_code": null,
  "financial_account": "fa_1MtkSr2eZvKYlo2CsJozwFWD",
  "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOKVuaEGMgagXvSInCY6NpMvimqdsEKNHRrHZ3OGyVm_l5LfDMezNeY83F5Mq-rryXZ-J1z-jfFBv30wz5WxDH97VRBIzw",
  "initiating_payment_method_details": {
    "billing_details": {
      "address": {
        "city": null,
        "country": null,
        "line1": null,
        "line2": null,
        "postal_code": null,
        "state": null
      },
      "email": null,
      "name": "Jane Austen"
    },
    "type": "us_bank_account",
    "us_bank_account": {
      "bank_name": "STRIPE TEST BANK",
      "last4": "6789",
      "routing_number": "110000000"
    }
  },
  "linked_flows": {
    "credit_reversal": null,
    "issuing_authorization": null,
    "issuing_transaction": null,
    "source_flow": null,
    "source_flow_type": null
  },
  "livemode": false,
  "network": "ach",
  "reversal_details": {
    "deadline": 1681084800,
    "restricted_reason": null
  },
  "status": "succeeded",
  "transaction": "trxn_1MtkSr2eZvKYlo2CuFFh9Rh0"
}

Retrieve a ReceivedCredit

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

Parameters

No parameters.

Returns

Returns a ReceivedCredit object.

GET /v1/treasury/received_credits/:id

Server-side language

curl https://api.stripe.com/v1/treasury/received_credits/rc_1MtkSr2eZvKYlo2CcysvUbEw \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "rc_1MtkSr2eZvKYlo2CcysvUbEw",
  "object": "treasury.received_credit",
  "amount": 1000,
  "created": 1680755425,
  "currency": "usd",
  "description": "Stripe Test",
  "failure_code": null,
  "financial_account": "fa_1MtkSr2eZvKYlo2CsJozwFWD",
  "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOKVuaEGMgagXvSInCY6NpMvimqdsEKNHRrHZ3OGyVm_l5LfDMezNeY83F5Mq-rryXZ-J1z-jfFBv30wz5WxDH97VRBIzw",
  "initiating_payment_method_details": {
    "billing_details": {
      "address": {
        "city": null,
        "country": null,
        "line1": null,
        "line2": null,
        "postal_code": null,
        "state": null
      },
      "email": null,
      "name": "Jane Austen"
    },
    "type": "us_bank_account",
    "us_bank_account": {
      "bank_name": "STRIPE TEST BANK",
      "last4": "6789",
      "routing_number": "110000000"
    }
  },
  "linked_flows": {
    "credit_reversal": null,
    "issuing_authorization": null,
    "issuing_transaction": null,
    "source_flow": null,
    "source_flow_type": null
  },
  "livemode": false,
  "network": "ach",
  "reversal_details": {
    "deadline": 1681084800,
    "restricted_reason": null
  },
  "status": "succeeded",
  "transaction": "trxn_1MtkSr2eZvKYlo2CuFFh9Rh0"
}

List all ReceivedCredits

Returns a list of ReceivedCredits.

Parameters

financial_accountstringRequired
The FinancialAccount that received the funds.

linked_flowsobject
Only return ReceivedCredits described by the flow.

statusenum
Only return ReceivedCredits that have the given status: succeeded or failed.
Possible enum values
failed
The ReceivedCredit was declined, and no Transaction was created.
succeeded
The ReceivedCredit was approved.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit ReceivedCredits, starting after ReceivedCredit starting_after. Each entry in the array is a separate ReceivedCredit object. If no more ReceivedCredits are available, the resulting array will be empty.

GET /v1/treasury/received_credits

Server-side language

curl -G https://api.stripe.com/v1/treasury/received_credits \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d financial_account=fa_1MtkSr2eZvKYlo2CsJozwFWD \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/treasury/received_credits",
  "has_more": false,
  "data": [
    {
      "id": "rc_1MtkSr2eZvKYlo2CcysvUbEw",
      "object": "treasury.received_credit",
      "amount": 1000,
      "created": 1680755425,
      "currency": "usd",
      "description": "Stripe Test",
      "failure_code": null,
      "financial_account": "fa_1MtkSr2eZvKYlo2CsJozwFWD",
      "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOKVuaEGMgagXvSInCY6NpMvimqdsEKNHRrHZ3OGyVm_l5LfDMezNeY83F5Mq-rryXZ-J1z-jfFBv30wz5WxDH97VRBIzw",
      "initiating_payment_method_details": {
        "billing_details": {
          "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "postal_code": null,
            "state": null
          },
          "email": null,
          "name": "Jane Austen"
        },
        "type": "us_bank_account",
        "us_bank_account": {
          "bank_name": "STRIPE TEST BANK",
          "last4": "6789",
          "routing_number": "110000000"
        }
      },
      "linked_flows": {
        "credit_reversal": null,
        "issuing_authorization": null,
        "issuing_transaction": null,
        "source_flow": null,
        "source_flow_type": null
      },
      "livemode": false,
      "network": "ach",
      "reversal_details": {
        "deadline": 1681084800,
        "restricted_reason": null
      },
      "status": "succeeded",
      "transaction": "trxn_1MtkSr2eZvKYlo2CuFFh9Rh0"
    }
  ]
}

Test mode: Create a ReceivedCredit Test helper

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

Parameters

amountintegerRequired
Amount (in cents) to be transferred.

currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.

financial_accountstringRequired
The FinancialAccount to send funds to.

networkenumRequired
Specifies the network rails to be used. If not set, will default to the PaymentMethod’s preferred network. See the docs to learn more about money movement timelines for each network type.

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

initiating_payment_method_detailsobject
Initiating payment method details for the object.

Returns

A test mode ReceivedCredit object.

POST /v1/test_helpers/treasury/received_credits

Server-side language

curl https://api.stripe.com/v1/test_helpers/treasury/received_credits \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d amount=1000 \
  -d currency=usd \
  -d financial_account=fa_1MtkSr2eZvKYlo2CsJozwFWD \
  -d network=ach

Response

{
  "id": "rc_1MtkSr2eZvKYlo2CcysvUbEw",
  "object": "treasury.received_credit",
  "amount": 1000,
  "created": 1680755425,
  "currency": "usd",
  "description": "Stripe Test",
  "failure_code": null,
  "financial_account": "fa_1MtkSr2eZvKYlo2CsJozwFWD",
  "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOKVuaEGMgagXvSInCY6NpMvimqdsEKNHRrHZ3OGyVm_l5LfDMezNeY83F5Mq-rryXZ-J1z-jfFBv30wz5WxDH97VRBIzw",
  "initiating_payment_method_details": {
    "billing_details": {
      "address": {
        "city": null,
        "country": null,
        "line1": null,
        "line2": null,
        "postal_code": null,
        "state": null
      },
      "email": null,
      "name": "Jane Austen"
    },
    "type": "us_bank_account",
    "us_bank_account": {
      "bank_name": "STRIPE TEST BANK",
      "last4": "6789",
      "routing_number": "110000000"
    }
  },
  "linked_flows": {
    "credit_reversal": null,
    "issuing_authorization": null,
    "issuing_transaction": null,
    "source_flow": null,
    "source_flow_type": null
  },
  "livemode": false,
  "network": "ach",
  "reversal_details": {
    "deadline": 1681084800,
    "restricted_reason": null
  },
  "status": "succeeded",
  "transaction": "trxn_1MtkSr2eZvKYlo2CuFFh9Rh0"
}

Received Credits

The ReceivedCredit object

Attributes

idstring

objectstring

amountinteger

createdtimestamp

currencyenum

descriptionstring

failure_codenullable enum

financial_accountnullable string

hosted_regulatory_receipt_urlnullable string

initiating_payment_method_detailsobject

linked_flowsobject

livemodeboolean

networkenum

reversal_detailsnullable object

statusenum

transactionnullable stringExpandable

Retrieve a ReceivedCredit

Parameters

Returns

List all ReceivedCredits

Parameters

financial_accountstringRequired

linked_flowsobject

statusenum

More parametersExpand all

ending_beforestring

limitinteger

starting_afterstring

Returns

Test mode: Create a ReceivedCredit Test helper

Parameters

amountintegerRequired

currencyenumRequired

financial_accountstringRequired

networkenumRequired

descriptionstring

initiating_payment_method_detailsobject

Returns

More parameters