Nodes

The node field is a dynamic object inside a payment-node and defines the specific resource used to execute the payment depending on the value of origin or destination type.

Each type unlocks a different structure for the node field. Only one node structure is allowed per payment-node, and it must match the declared type.

Below are the supported node types and their expected structure by payment-node type.

Payment initiation

Represents a reusable or one-time link to initiate a payment.

Payment-node type
node

PAYMENT_INITIATION

paymentInitiation

Required node fields

Fields
Description

provider

Payment initiation provider.

referenceId

Identifier of the account in the payment initiation provider.

redirectUrl

URL where the user will be redirected after completing the payment.

Origin request example

    {
      "type": "PAYMENT_INITIATION",
      "paymentInitiation": {
        "provider": "PLAID",
        "referenceId": "1230222",
        "redirectUrl": "https://url.com"
      }
    }

Notes

  • For some payment initiation providers, bank accounts can be registered. When this occurs, the referenceId field is required.

  • When a bank account is successfully registered, the account information will be sent via webhook notification.

  • The response returns the referenceToken, which is required to continue the payment flow.

  • The language field can be used to localize the user experience. Only some providers support this field — refer to the Payment Methods page for more details.

  • The minimumAmount and maximumAmount fields define the allowed transaction range for this payment initiation.

Account

Represents an internal account within the conomy_hq.

Payment-node type
node

ACCOUNT

account

Required node fields

Fields
Description

accountNumber

Internal reference number for the account

Origin/Destination request example

{
  "type": "ACCOUNT",
  "currency": "CLP",
  "account": {
    "accountNumber": "174XXX"
  }
}
Bank account

Represents an external bank account, typically used for payouts or remittances.

Payment-node type
node

BANK_ACCOUNT

bank

Required node fields

Fields
Description

accountNumber

The bank account number.

typeAccount

The type of bank account. CHECKING_ACOUNT SAVINGS

bank

The name of the bank where the account is held.

accountHolder

The full name of the account holder.

accountHolderDni

The national identification number or tax ID of the account holder.

country

The country of the bank account.

currency

The currency of the bank account.

Origin/Destination request example

    {
      "type": "BANK_ACCOUNT",
      "bank": {
        "accountNumber": "11111111",
        "bank": "BANCO_SANTANDER",
        "currency": "CLP",
        "country": "CHL",
        "typeAccount": "CHECKING_ACCOUNT",
        "accountHolder": "John Doe",
        "accountHolderDni": "162115031-7",
      }
    }
Card

Card-based payments (debit, credit, prepaid).

Payment-node type
node

CARD

card

Required node fields

Fields
Description

token

Card token

Origin request example

    {
      "type": "CARD",
      "card": {
        "token": "111111111111"
      }
    }

Notes

  • To perform a card payment via API, the card must first be pre-registered and tokenized. Refer to the Payment Methods page for more information on how to tokenize cards.

  • The response will include the card holder and a masked card number containing the last 4 digits.

Crypto

Crypto wallet for sending or receiving crypto.

Payment-node type
node

CRYPTO

wallet

Required node fields

Fields
Description

address

Wallet's address

Origin request example

    {
      "type": "CRYPTO",
      "wallet": {
        "address": "0x123...456"
      }
    }

Last updated