Skip to main content

Get spending prerequisites

POST 

/api/spending-prerequisites

This endpoint specifies the necessary prerequisites that must be met for a cardholder to successfully create a card and transact with it against a specified Funding Source. The caller can specify the desired spend and receive the necessary transactions required, accounting for existing deposits, to deposit funds on-chain to meet that spend. It includes any KYC and AML requirements.

Request

Body

required

    cardProgramId stringrequired

    ID of card program to create the card under

    fundingSourceId stringrequired

    ID of the Funding Source the card will authorize against

    spendableAmount stringrequired

    Amount of fiat money that should be available on the card, denominated in minor units

    spendableCurrency stringrequired

    Possible values: [USD]

    Currency to be used when creating the card. Currently only supports USD

    kycType string

    Possible values: [immersve-conducted, partner-conducted]

    Type of KYC depending on which party is conducting it

    kycRedirectUrl string

    A URL to which the user can be redirected after they have completed or exited the kyc process.

    kycRegion string

    An Alpha3 (ISO-3166-1) country code representing the country in which the user is being KYC'd.

Responses

Schema

    prerequisites

    object[]

  • Array [

  • type string

    Possible values: [smart_contract_write, kyc, contact_email, contact_phone]

    params

    object

    oneOf

    contractAddress string

    The address of the smart contract

    abi

    object[]

    The JSON ABI of the smart contract (contains only required details. more details here https://docs.soliditylang.org/en/v0.8.19/abi-spec.html#json)

  • Array [

  • type string

    Possible values: [function]

    name string

    The name of the function

    inputs

    object[]

  • Array [

  • name string

    The name of the parameter

    type string

    The type of the parameter

  • ]

  • ]

  • method string

    Smart contract method

    params object

    Smart contract call params. Keys are matching names and order defined in ABI

  • ]

Loading...