Create a funding source for an account

POST 
/api/funding-sources

This endpoint can be used to claim a web3 address as a source of funds. The funding address may be an EOA or a smart contract implementing the ERC-1271 interface. If the address is a smart contract, the ownerAddress, message, and signature fields are required.
The Create challenge endpoint can be used to prove ownership of a web3 address by signing the returned message.

Request

application/json

Body

required

oneOf

create-funding-source-eoa

accountId stringrequired

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

fundingAddress stringrequired

The address to claim as a Funding Source. This can be a smart contract implementing ERC-1271 or an EOA address.

fundingChannelId stringrequired

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

create-funding-source-erc-1271

accountId stringrequired

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

fundingAddress stringrequired

The address to claim as a Funding Source. This can be a smart contract implementing ERC-1271 or an EOA address.

ownerAddress stringrequired

EOA address that matches a login wallet.

fundingChannelId stringrequired

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

message stringrequired

An EIP-4361 message which is signed by the ownerAddress. This is used to verify ownership of the owner address.

signature stringrequired

The signature of the message.

create-funding-source-challenge

accountId stringrequired

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

fundingAddress stringrequired

The address to claim as a Funding Source. This can be a smart contract implementing ERC-1271 or an EOA address.

fundingChannelId stringrequired

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

challengeId stringrequired

Id of challenge returned by Create challenge endpoint

signature stringrequired

Signature generated by signing message from challenge returned by Create challenge endpoint

Responses

200

Successful operation

application/json

Schema

Schema

id string

Funding Source primary identifier

accountId string

Cardholder account this Funding Source belongs to

createdAt string

Timestamp of Funding Source creation

balance string

Current balance of Funding Source in minor units

balanceCurrency string

Currency of the balance

fundingChannelId string

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

Example (from schema)

{
  "id": "91ad6fea3b52ca58d60d7fd310f789ec",
  "accountId": "057aa15913a57f50577234c8426534c0",
  "createdAt": "2022-11-16T03:13:18.142Z",
  "balance": "1000000",
  "balanceCurrency": "USDC",
  "fundingChannelId": "315bad4e81ce0f26966a41b9d451638b"
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

403

User is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN Insufficient permissions to perform the action.

SIGNATURE_DENIED The signature was rejected by the ERC-1271 contract isValidSignature function.

SIGNATURE_INVALID The message signature was invalid.

ADDRESS_MISMATCH The ownerAddress does not match the EIP-4361 message address.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...