Adding child entities

Optional feature typically used for platforms (e.g. creator platform or payroll platforms)

Platforms such as creator platforms or payroll platforms can utilize Loop to collect or send crypto payments on their platform.

When the Loop contract is deployed, an entity is created with the following fields (below). Loop allows for users to create child entities linked to the parent.

Child entities have the same fields as parent. Thus, each child has its own custom checkout page (even if not relevant for a specific use case), list of accepted tokens, inbound treasury, items, etc. An entity must be created before Items such as subscriptions or one-time payments are created. However, you can create an entity and configure the items in the same request by providing the details.

PreviousEntity NextAdding user to child entity

Last updated 1 year ago

post

Authorizations

Header parameters

entity-idstringrequired

Body

namestringrequired

The name of the entity using Loop

Example: Professional

inboundTreasuriesobjectoptional

The addresses of the wallets receiving transfers per network

logoUrlstringoptional

URL link to the entity's logo

Example: https://www.loopcrypto.xyz/logo.svg

websiteUrlstringoptional

URL link to the entity's website

Example: https://www.loopcrypto.xyz

signupRedirectUrlstringoptional

URL to redirect on signup for entity

Example: https://www.loopcrypto.xyz/success

delegatedSigningbooleanoptional

A flag to indicate if the entity is using delegated signing

Example: true

chargebeeEnabledbooleanoptional

(Optional) A flag to indicate if the entity is using Chargebee

Example: true

chargebeeSiteNamestringoptional

(Optional) The name of the Chargebee site

Example: loopcrypto

chargebeeApiKeystringoptional

(Optional) The API key for the Chargebee site

Example: test_1234567890

stripeEnabledbooleanoptional

(Optional) A flag to indicate if the entity is using Stripe

Example: true

quickBooksEnabledbooleanoptional

(Optional) A flag to indicate if the entity is using QuickBooks

Example: true

stripeApiKeystringoptional

(Optional) The API key for the Stripe account

Example: sk_test_1234567890

externalAccountIdstringoptional

(Optional) The external account ID for an entity.

Example: acct_1234567890

backgroundStylestringoptional

(Optional) Customizable CSS style to personalize the user experience, defaults to #f5f5f5

Example: linear-gradient(180deg, #000000 0%, #45E0A8 100%), #45E0A8

itemsobject[]optional

(Optional) A list of items to create and be linked to the entity

networkFeeEnabledbooleanoptionalDeprecated

Whether network fees are enabled for an entity

Example: false

emailstringoptional

(Optional) Email for child user

replyTostringoptional

(Optional) The email address to use as the reply-to address for company emails

Example: reply@mycompany.com

cancellationDaysThresholdnumber · doubleoptional

(Optional) The number of days a payment is retried before an agreement is cancelled

Example: 137

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.loopcrypto.xyz/api/v1/entities' \
  --header 'api-key: YOUR_API_KEY' \
  --header 'entity-id: text' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "name": "Professional",
      "inboundTreasuries": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "logoUrl": "https://www.loopcrypto.xyz/logo.svg",
      "websiteUrl": "https://www.loopcrypto.xyz",
      "signupRedirectUrl": "https://www.loopcrypto.xyz/success",
      "delegatedSigning": true,
      "chargebeeEnabled": true,
      "chargebeeSiteName": "loopcrypto",
      "chargebeeApiKey": "test_1234567890",
      "stripeEnabled": true,
      "quickBooksEnabled": true,
      "stripeApiKey": "sk_test_1234567890",
      "externalAccountId": "acct_1234567890",
      "backgroundStyle": "linear-gradient(180deg, #000000 0%, #45E0A8 100%), #45E0A8",
      "items": [
        {
          "name": "The Professional Plan",
          "amount": 29.99,
          "frequency": "WEEK",
          "frequencyCount": 2,
          "acceptedTokens": {
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "entityId": "4d1f3191-935b-40c5-b91e-37e1e3700bac",
          "externalId": "orbf9e15-e54b-11ec-b21b-06d24995f946",
          "active": true,
          "priceMetadata": "Increases to $200 after 2 weeks",
          "typeId": "1",
          "categoryId": 10,
          "autoInvoice": false,
          "initialOffset": 1
        }
      ],
      "networkFeeEnabled": false,
      "email": "text",
      "replyTo": "reply@mycompany.com",
      "cancellationDaysThreshold": 137
    }
  ]'

200

400

401

403

422

500

504

{
  "name": "Professional",
  "inboundTreasuries": {
    "1": [
      "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
    ]
  },
  "logoUrl": "https://www.loopcrypto.xyz/logo.svg",
  "websiteUrl": "https://www.loopcrypto.xyz",
  "signupRedirectUrl": "https://www.loopcrypto.xyz/success",
  "delegatedSigning": true,
  "entityId": "9906361a-7114-4756-9e7c-0752fd8378e8",
  "backgroundStyle": "linear-gradient(180deg, #000000 0%, #45E0A8 100%), #45E0A8",
  "items": [
    {
      "name": "The Professional Plan",
      "amount": 29.99,
      "frequency": "MONTH",
      "frequencyCount": 1,
      "acceptedTokens": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "externalId": "price_1ObTC0EsKlmFX3FHDjZnmim1",
      "active": true,
      "priceMetadata": "Increases to $200 after 2 weeks",
      "autoInvoice": true,
      "initialOffset": 1,
      "itemId": "2a697faf-8fdb-4aab-be20-64db0cef7dd5",
      "entityId": "4d1f3191-935b-40c5-b91e-37e1e3700bac",
      "url": "https://checkout.loopcrypto.xyz/4d1f3191-935b-40c5-b91e-37e1e3700bac/2a697faf-8fdb-4aab-be20-64db0cef7dd5",
      "type": "Subscription",
      "category": "Books, Periodicals, and Newspapers",
      "categoryCode": 5192
    }
  ],
  "networkFeeEnabled": false,
  "userCreated": true,
  "replyTo": "reply@mycompany.com",
  "cancellationDaysThreshold": 7
}

Show child attributes

Show child attributes