Skip to main content

Create Funding Source

POST 
/api/funding-sources

Funding Sources define the mechanism for how card payments will be funded. A Funding Source's Funding Channel defines its purpose, protocol, and asset type as well as any other common parameters. Other parameters vary depending on the type of Funding Channel and also vary by the funding address validation mode if applicable.

Funding Sources with on-chain Funding will have a fundingAddress attribute. The address will vary depending on the protocol variant in use. For a universal protocol variant it will be the deposit sender address. For flexi protocol variants it will be the deposit recipient address. See Funding Protocols for more details about funding protocols.

The purpose of a Funding Source is inherited from its Funding Channel. If the Funding Source has a "billing" purpose, then it cannot be used to fund cards directly. Rather, it will be used to create a custodial Funding Channel.

Request Variants​

Login Wallet Create a Funding Source using a funding address which is already connected with a verified login wallet for the owner account.

Wallet Signature Create a Funding Source using funding address which can be verified with a separate signing challenge. The Create challenge endpoint can be used to generate the signing challenge required to prove ownership of a web3 address.

Custodial Cardholder Create a Funding Source that uses the Custodial Funding Protocol. The external id parameter is required.

Simulator Create a Funding Source that uses the Simulator Funding Protocol. No additional parameters are required.

Request​

Body

required

    oneOf

    accountId stringrequired

    The ID of the account to add this Funding Source to.

    fundingAddress stringrequired

    The address to claim as a Funding Source. For universal protocol variants this would be the sender address for deposits. For flexi protocol variants this would be recipient address for deposits.

    fundingChannelId stringrequired

    The id of the Funding Channel that this Funding Source relates to.

Responses​

Successful operation

Schema

    id stringrequired

    Funding Source primary identifier.

    accountId stringrequired

    Cardholder account this Funding Source belongs to.

    createdAt stringrequired

    Timestamp of Funding Source creation.

    balance stringrequired

    Current balance of Funding Source in minor units.

    balanceCurrency stringrequired

    Currency of the balance.

    fundingChannelId stringrequired

    The ID of the Funding Channel that this Funding Source relates to.

    externalId stringrequired

    Funding address for on-chain Funding, or customer specified ID for off-chain Funding.

    purpose stringrequired

    The purpose of the Funding Channel.

    network string

    Network of Funding Source with on-chain Funding.

Loading...