Nodes

A node is a payment endpoint. It can be an origin (where funds come from) or a destination (where funds go).

Each node has:

  • type: rail identifier in uppercase.

  • currency: ISO 4217 currency code.

  • A rail payload object whose name matches type in camelCase.

Example:

  • type: "SPEI" -> payload object spei: {}.

How nodes work

Every payment includes origins and destinations arrays. Each array item is a node.

{
  "origins": [
    {
      "type": "PIX",
      "currency": "BRL",
      "pix": {
        "customer": {
          "firstName": "Joao",
          "lastName": "Silva",
          "email": "[email protected]",
          "documentNumber": "12345678901"
        }
      }
    }
  ],
  "destinations": [
    {
      "type": "ACCOUNT",
      "currency": "BRL",
      "account": {
        "accountNumber": "acc_123"
      }
    }
  ]
}

Base node fields

  • type (string): rail identifier in uppercase (for example PIX, ACH, SEPA).

  • currency (string): ISO 4217 code (for example BRL, USD, EUR).

  • amount (string): amount in the smallest currency unit.

  • railPayload (object): rail-specific object matching the type.

Rail summary

  • PIX: Brazil, BRL, pay-in and pay-out.

  • PCT: Argentina, ARS, pay-in.

  • CVU: Argentina, ARS, pay-in.

  • ETPAY: Chile, CLP, pay-in.

  • FINTOC: Chile, CLP, pay-in.

  • WEBPAY: Chile, CLP, pay-in.

  • SPEI: Mexico, MXN, pay-in and pay-out.

  • PSE: Colombia, COP, pay-in.

  • BANCOLOMBIA: Colombia, COP, pay-in.

  • DAVIVIENDA: Colombia, COP, pay-in.

  • DAVIPLATA: Colombia, COP, pay-in and pay-out.

  • NEQUI: Colombia, COP, pay-in and pay-out.

  • BREB: Colombia, COP, pay-out.

  • WOMPI: Colombia, COP, pay-in.

  • PAGO_MOVIL: Venezuela, VES, pay-in.

  • ACH: USA, USD, pay-in and pay-out.

  • WIRE: USA, USD, pay-out.

  • FEDNOW: USA, USD, pay-in and pay-out.

  • RTP: USA, USD, pay-in.

  • SEPA: Europe, EUR, pay-out.

  • SWIFT: International, multi-currency, pay-out.

  • FPE: UK, GBP, pay-out.

  • ACCOUNT: platform account, pay-in and pay-out.

  • BANK_ACCOUNT: generic bank account, pay-out.

Customer object

Many rails require a customer object inside the rail payload.

  • firstName (string)

  • lastName (string)

  • email (string)

  • phoneNumber (string)

  • phoneNumberPrefix (string)

  • documentNumber (string)

  • documentType (string)

  • country (string, ISO 3166-1 alpha-2)

  • address (object)

After submission

For redirect rails (PIX, PCT, ETPAY, WEBPAY, WOMPI, PSE, BANCOLOMBIA, DAVIVIENDA), the response includes a url or qrCode and the end user must complete the flow.

For direct rails (ACH, SEPA, SPEI pay-out, FPE, WIRE, SWIFT, CRYPTO), funds are routed directly.

Payment status usually transitions from CREATED to PENDING to COMPLETED (or FAILED).

Last updated