POST /v1/customers/{customer}/funding_instructions

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

Servers

Path parameters

Name Type Required Description
customer String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
funding_type String Yes

The funding_type to get the instructions for.

Possible values:

  • "bank_transfer"
expand[] Array No

Specifies which fields in the response should be expanded.

currency String Yes

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

bank_transfer Object Yes

Additional parameters for bank_transfer funding types

bank_transfer.type String Yes

Possible values:

  • "jp_bank_transfer"
  • "mx_bank_transfer"
  • "eu_bank_transfer"
  • "gb_bank_transfer"
  • "us_bank_transfer"
bank_transfer.eu_bank_transfer Object No
bank_transfer.eu_bank_transfer.country String Yes
bank_transfer.requested_address_types[] Array No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.