The Funding Instruction object

Attributes

bank_transferobject
Details to display instructions for initiating a bank transfer

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

funding_typeenum
The funding_type of the returned instructions
Possible enum values
bank_transfer
Use a bank_transfer hash to define the bank transfer type

More attributes

objectstring

livemodeboolean

The Funding Instruction object

{
  "object": "funding_instructions",
  "bank_transfer": {
    "country": "DE",
    "financial_addresses": [
      {
        "iban": {
          "account_holder_name": "Stripe Technology Europe Limited",
          "bic": "SXPYDEHH",
          "country": "DE",
          "iban": "DE00000000000000000001"
        },
        "supported_networks": [
          "sepa"
        ],
        "type": "iban"
      }
    ],
    "type": "eu_bank_transfer"
  },
  "currency": "eur",
  "funding_type": "bank_transfer",
  "livemode": false
}

Create funding instructions

Create or retrieve funding instructions for an Issuing balance. If funding instructions don’t yet exist for the account, we’ll create new funding instructions. If we’ve already created funding instructions for the account, we’ll retrieve the same funding instructions. In other words, we’ll return the same funding instructions each time.

Parameters

bank_transferobjectRequired
Additional parameters for bank_transfer funding types

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

funding_typeenumRequired
The funding_type to get the instructions for.
Possible enum values
bank_transfer
Use a bank_transfer hash to define the bank transfer type

Returns

Returns funding instructions for an Issuing balance

POST /v1/issuing/funding_instructions

Server-side language

curl https://api.stripe.com/v1/issuing/funding_instructions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "bank_transfer[type]"=eu_bank_transfer \
  -d currency=eur \
  -d funding_type=bank_transfer

Response

{
  "object": "funding_instructions",
  "bank_transfer": {
    "country": "DE",
    "financial_addresses": [
      {
        "iban": {
          "account_holder_name": "Stripe Technology Europe Limited",
          "bic": "SXPYDEHH",
          "country": "DE",
          "iban": "DE00000000000000000001"
        },
        "supported_networks": [
          "sepa"
        ],
        "type": "iban"
      }
    ],
    "type": "eu_bank_transfer"
  },
  "currency": "eur",
  "funding_type": "bank_transfer",
  "livemode": false
}

List all funding instructions

Retrieve all applicable funding instructions for an Issuing balance.

Parameters

No parameters.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

Returns all funding instructions for an Issuing balance

GET /v1/issuing/funding_instructions

Server-side language

curl -G https://api.stripe.com/v1/issuing/funding_instructions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/issuing/funding_instructions",
  "has_more": false,
  "data": [
    {
      "object": "funding_instructions",
      "bank_transfer": {
        "country": "DE",
        "financial_addresses": [
          {
            "iban": {
              "account_holder_name": "Stripe Technology Europe Limited",
              "bic": "SXPYDEHH",
              "country": "DE",
              "iban": "DE00000000000000000001"
            },
            "supported_networks": [
              "sepa"
            ],
            "type": "iban"
          }
        ],
        "type": "eu_bank_transfer"
      },
      "currency": "eur",
      "funding_type": "bank_transfer",
      "livemode": false
    }
  ]
}

Simulate a top up Test helper

Simulates an external bank transfer and adds funds to an Issuing balance. This method can only be called in test mode.

Parameters

amountintegerRequired
The amount to top up

currencyenumRequired
The currency to top up

Returns

Returns testmode funding instructions for an Issuing balance

POST /v1/test_helpers/issuing/fund_balance

Server-side language

curl https://api.stripe.com/v1/test_helpers/issuing/fund_balance \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d amount=4242 \
  -d currency=eur

Response

{
  "object": "funding_instructions",
  "bank_transfer": {
    "country": "DE",
    "financial_addresses": [
      {
        "iban": {
          "account_holder_name": "Stripe Technology Europe Limited",
          "bic": "SXPYDEHH",
          "country": "DE",
          "iban": "DE00000000000000000001"
        },
        "supported_networks": [
          "sepa"
        ],
        "type": "iban"
      }
    ],
    "type": "eu_bank_transfer"
  },
  "currency": "eur",
  "funding_type": "bank_transfer",
  "livemode": false
}