Payment References
Payment References retrieves the reference codes a customer needs to make a payment. These are the account numbers or reference strings they enter at a bank, payment gateway, or other provider — the identifiers that link an incoming payment back to their account.
This node requires the customer to be linked to the Credit Management System. If the borrower has no CMS connection, the node routes to error.
When to Use It
Collection flows. When customers ask how to pay, retrieve their references and display which banks accept payments and what number to use at each one.
Account inquiries. Customers checking their payment status or looking for their reference number can get it directly in conversation.
Payment reminders. Proactive messages that include the exact reference code, so customers can pay without hunting for information.
Each reference includes a status — ACTIVE, APPLIED, IN_PROCESS, and others. You may want to filter for active references before displaying them.
Configuration
| Option | Description |
|---|---|
partnerIdVariable | Variable containing the partner ID for CMS authentication (required) |
selectedVariable | Variable where the references array will be stored |
selectedVariableType | Data type for the output variable (defaults to object) |
Set the partner ID earlier in your flow using a Set Variable node.
The output variable receives an array of payment references. Each reference includes the provider name (like "BANCO PICHINCHA"), the reference number itself, status, a unique identifier, and creation timestamp. See Payment Accounts API for the full response structure.
To display references to customers, access the array in a Message node using variable syntax like {{payment_info.references[0].provider}} and {{payment_info.references[0].reference}}.
Output Handles
| Handle | When |
|---|---|
| Continue | References retrieved successfully |
| Error | Missing configuration, borrower not linked to CMS, or API failure |
Things to Know
The borrower must be authenticated. This node runs in the context of a conversation with an identified borrower. It will not work before authentication.
CMS linkage is required. The borrower record must have CMS client IDs associated with it. Without this connection, the node has nowhere to fetch references from and will route to error.