1. Resources
Cash-In API
  • Introduction
  • Authentication & security
  • Environments
  • Errors
  • Contact us
  • Resources
    • Services
    • Invoice Intermediation service
    • Invoice Lifecycle service
    • Debt Collection service
    • Debt Collection process
    • Cash-In Client Portal
    • Print & Distribution service
    • Confirma Software Partner services
    • Go-Live & Deployment Guide
    • General data types
    • Invoice Service Data types
    • Release Notes
  • Token endpoints
    • Validate token
      GET
    • Renew token
      GET
  • Collection endpoints
    • Create Collection Cases
      POST
    • Update Collection Receivables
      POST
    • Retrieve Collection Receivables Status
      GET
    • Retrieve Case Batch Status
      GET
    • Retrieve collection case
      GET
    • Retrieve debtor summary
      GET
    • Retrieve list of settlements
      GET
    • Retrieve settlement data
      GET
    • Retrieve list of direct settlements
      GET
    • Retrieve direct settlement data
      GET
    • Retrieve Credit Loss Receivables
      GET
    • Retrieve allocated payment transactions
      GET
  • Invoice endpoints
    • Invoice Service
      • Create an invoice
      • Create an invoice with seller information
      • Submit a batch of sales invoices
      • List batch uploads and export lines
      • List all sales invoices
      • Retrieve invoice delivery information
      • Retrieve invoice status
      • Update an invoice
      • Submit payment for an invoice
      • Retrieve delivery statistics
      • Retrieve received payments
      • Submit update to Finvoice Account
      • Retrieve electronic invoicing contracts
    • Product Management
      • List all products
      • Submit new products
      • Delete an product
    • Customer Management
      • List all customers
      • Submit new customers
      • Update an customer
      • Delete an customer
    • External invoices
      • Retrieve delivery information
      • Retrieve payment information
      • Create an direct payment
      • Submit an invoice action
      • Retrieve status of the agreement
  • Partner endpoints
    • Submit new creditor
    • Update creditor
    • Retrieve Creditor Credentials
    • Retrieve Finvoice Credentials
    • Retrieve External Agreement Identifiers
    • Retrieve invoice delivery information by seller
    • Send SMS message
  • Document endpoints
    • Create meter reading documents
  • Operations endpoints
    • Service Status
  • Schemas
    • BatchDataResponse
    • SalesInvoiceBatchResponse
    • OnlineInvoiceBatchProcedureOutcomeDto
    • OnlineInvoiceBatchListResponse
    • OnlineInvoiceBatchListItemDto
    • OnlineInvoiceBatchExportLineDto
    • AllocatedPaymentTransactionsResponse
    • Finvoice Registry Credentials Record
    • BatchInvoices
    • AllocatedPaymentTransactionItem
    • SalesInvoice
    • BatchInvoicesList
    • PaymentTypeInfo
    • BatchStatus
    • PaymentDatesInfo
    • Case
    • PaymentAmountsInfo
    • CaseInvoiceExtended
    • AllocatedPaymentTransactionsMeta
    • CaseList
    • CaseSummary
    • CollectionResponse
    • ContactPerson
    • CreditLossReceivable
    • Creditor
    • CreditorData
    • CreditorDetails
    • CreditorIdentifiers
    • CreditorResponse
    • CreditorUpdateData
    • CreditorUpdateDetails
    • CreditorUpdateResponse
    • CustomParameters
    • Debtor
    • DirectSettlementList
    • DirectSettlementRows
    • DirectSettlements
    • DocumentCustomer
    • DocumentResponse
    • ElectronicInvoicingContracts
    • ErrorMessage
    • ExternalAgreementIdentifiers
    • ExternalAgreementStatusResponse
    • ExternalInvoice
    • ExternalInvoiceActions
    • ExternalInvoiceRows
    • FinvoiceAccountUpdate
    • FinvoiceAccountUpdateResponse
    • IntegrationsAccountingLedgerData
    • IntermediationInvoiceDirectPaymentResponse
    • IntermediationInvoiceDirectPayments
    • IntermediatorInvoice
    • Invoice
    • InvoiceActionResponse
    • InvoicePaymentsResponse
    • InvoicesDeliveryInformation
    • LedgerRowDimensions
    • LedgerRows
    • Ledgers
    • Messages
    • MeterCompany
    • MeterDocument
    • MeterDocumentList
    • MeterReading
    • MeterUsageLocation
    • NxsReceivedPayments
    • OnlineCustomer
    • OnlineCustomerResponse
    • OnlineCustomerUpdateResponse
    • OnlineInvoicePaymentControl
    • OnlineProduct
    • OnlineSalesInvoices
    • PagedSalesInvoicesResponse
    • Payment
    • Receivable
    • ReceivablesList
    • ReceivedPaymentRows
    • ReceivedPayments
    • ReceivedPaymentsResponse
    • RenewResponse
    • SalesAddressDTO
    • SalesInvoiceBatchResponse
    • SalesInvoicePayment
    • SalesInvoiceResponse
    • SalesInvoiceRow
    • SalesInvoiceUpdate
    • SalesInvoiceUpdateResponse
    • SalesInvoiceWithSellerInfoDTO
    • SalesItemResponse
    • SalesItems
    • SellerInfoDTO
    • Settlement
    • SettlementList
    • SettlementRows
    • SmsData
    • SmsDeliveryReport
    • SmsResponse
    • ValidationResponse
    • ViewOnlineInvoiceDeliveryStats
Need help?
  1. Resources

Go-Live & Deployment Guide

Once your API endpoints are implemented and tested in the sandbox, the next stage is going live with the API client.
This page outlines the recommended steps to onboard clients and launch your integration smoothly.
Cash-In Deployment Services
As part of this step, you are required to involve the Cash-In Deployment before going live to ensure proper configuration, validation, and readiness.

Step 1: Client Onboarding#

Purpose: Establish the new client in the Cash-In Creditor Registry and provide the necessary credentials for live operations, and also securing the use of the proper service.
Key Actions:
1.
Collect the client’s basic details (name, creditor account, contact info).
2.
Register the client in Cash-In system and request a production access token.
3.
Assign the correct service type (Invoice Lifecycle, Invoice Intermediation, Debt Collection, or Partner Services).
4.
Verify permissions and ensure the client is linked to the correct creditor account.
KYC - Know Your Customer
After a new account is activated, the client enters the Know Your Customer (KYC) process — a regulatory verification step designed to confirm their identity, assess risk, and ensure compliance with anti-money laundering (AML) requirements before full account access is granted.

Step 2: Verify Integration in Production#

Purpose: To ensure your implementation works correctly with real data.
Checklist:
1.
Confirm the client’s access token works with production endpoints.
2.
Run a test invoice creation or payment retrieval for the client.
3.
Verify expected responses, including HTTP codes and data formats.
4.
Check that notifications, reminders, and settlement workflows are triggered correctly (if using Invoice Lifecycle).

Step 3: Go-Live Confirmation#

Purpose: Officially enable the client to start using the live API.
Actions:
1.
Notify the client that production access is active.
2.
Monitor the first live requests for errors or unexpected behavior.
3.
Validate that settlements, reminders, or collection processes execute correctly.
4.
Enable monitoring and alerting for ongoing operations.

Step 4: Post Go-Live Support (optional)#

Purpose: Minimize disruptions and address any issues promptly.
1.
Provide access to support channels (email or ticketing).
2.
Document common errors and solutions for the client.
3.
Regularly review token usage and rotate tokens as part of security best practices.

Cash-In Deployment Services Overview#

Our Deployment Services are designed to support developers throughout the entire Go-Live process, ensuring a smooth onboarding experience for new clients and minimizing integration risk.
These services provide guidance, automation, and monitoring at every stage, so you can focus on delivering value without worrying about operational hurdles.
Key Benefits for Developers:
1.
Client Onboarding Support
Assistance with registering new clients and configuring creditor accounts.
Guidance on generating and managing production access tokens.
Verification that client permissions and service assignments are correct.
2.
Integration Verification
Tools to test API endpoints with production data safely.
Automated checks to ensure settlement workflows, reminders, and collections operate as expected.
Validation of error handling and response formats before full deployment.
3.
Go-Live Assistance
Step-by-step guidance for activating new clients.
Monitoring of initial live requests to catch issues early.
Recommendations for best practices in scaling the integration to multiple clients.
4.
Post-Go-Live Monitoring and Support
Continuous monitoring of API requests and token usage.
Alerts for errors, failed settlements, or collection exceptions.
Advice on token rotation, security, and operational maintenance.
Why It Matters
With the help from Deployment Services, developers can confidently move from sandbox testing to production, reduce the risk of integration errors, and provide clients with a seamless experience from day one.
Previous
Confirma Software Partner services
Next
General data types
Built with