Payments Module API

API reference for payment processing endpoints.

BriteCore v2 Payments API endpoint wrappers.

Provides helpers for payment method management, batch entry workflows, policy and invoice payments, sweep processing, and billing lookups.

britecore_sdk.api.api_calls.v2.payments.add_payment_method(card_expires_mm=None, ach_bank=None, customer_profile_id=None, card_cvv2=None, card_name_on=None, account_description=None, contact_id=None, ach_account=None, card_type=None, card_expires_yy=None, ach_type=None, ach_routing=None, ach_name_on=None, metadata=None, payment_method_type=None, card_number=None, address=None, vendor_payment_method_id=None, **kwargs)

Add a payment method for a contact..

POST /api/v2/payments/add_payment_method

Parameters:

• card_expires_mm (str | None)

• ach_bank (str | None)

• customer_profile_id (str | None)

• card_cvv2 (str | None)

• card_name_on (str | None)

• account_description (str | None)

• contact_id (str | None)

• ach_account (str | None)

• card_type (str | None)

• card_expires_yy (str | None)

• ach_type (str | None)

• ach_routing (str | None)

• ach_name_on (str | None)

• metadata (dict[str, Any] | None)

• payment_method_type (str | None)

• card_number (str | None)

• address (dict[str, Any] | None)

• vendor_payment_method_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.apply_selected_payments(payment_ids=None, print_deposit_receipt=None, **kwargs)

Apply selected payments and optionally generate a deposit receipt.

Use payment_ids to identify queued payments and print_deposit_receipt to request receipt generation after successful application. Returns the normalized process_result(...) payload, and **kwargs accepts RequestParameters overrides.

Parameters:

• payment_ids (list[str] | None)

• print_deposit_receipt (bool | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.change_payment_method(auto_payment_method_id=None, auto_pay_days_before=None, contact_id=None, policy_list=None, **kwargs)

Set a payment method across multiple policies..

POST /api/v2/payments/change_payment_method

Parameters:

• auto_payment_method_id (str | None)

• auto_pay_days_before (int | None)

• contact_id (str | None)

• policy_list (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.change_payment_method_single(auto_pay_days_before=None, contact_id=None, policy_term_id=None, auto_payment_method_id=None, override_propagation=None, policy_id=None, **kwargs)

Set a payment method for one policy or one policy term..

POST /api/v2/payments/change_payment_method_single

Parameters:

• auto_pay_days_before (int | None)

• contact_id (str | None)

• policy_term_id (str | None)

• auto_payment_method_id (str | None)

• override_propagation (bool | None)

• policy_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.create_payment_batch(data=None, **kwargs)

Create a payment batch record in the database..

POST /api/v2/payments/create_payment_batch

Parameters:

• data (dict[str, Any] | list[dict[str, Any]] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.create_payment_entries(entries=None, **kwargs)

Create payment entries from a serialized dataset..

POST /api/v2/payments/create_payment_entries

Parameters:

• entries (list[dict[str, Any]] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.delete_payment_batch(batch_id=None, **kwargs)

Remove a payment batch from the database.

Provide batch_id for the batch that should be deleted. Returns the normalized process_result(...) payload, and **kwargs may include RequestParameters overrides.

Parameters:

• batch_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.delete_payment_entries(entry_ids=None, **kwargs)

Delete payment entries by entry identifier..

POST /api/v2/payments/delete_payment_entries

Parameters:

• entry_ids (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.get_payment_method_info(payment_method_id=None, **kwargs)

Retrieve information about a stored payment method..

POST /api/v2/payments/get_payment_method_info

Parameters:

• payment_method_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.get_unpaid_invoices_by_date(due_date=None, bill_date=None, **kwargs)

Retrieve unpaid invoices for a bill date and/or due date..

POST /api/v2/payments/get_unpaid_invoices_by_date

Parameters:

• due_date (str | None)

• bill_date (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.import_payment_entries(entry_ids=None, bypass_duplicates_check=None, **kwargs)

Import staged payment entries into the accounting workflow..

POST /api/v2/payments/import_payment_entries

Parameters:

• entry_ids (list[str] | None)

• bypass_duplicates_check (bool | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.make_payment_by_contact_and_payment_method(policy_id=None, payment_amount=None, contact_id=None, payment_method_id=None, **kwargs)

Make a payment for a policy using a stored contact payment method..

POST /api/v2/payments/make_payment_by_contact_and_payment_method

Parameters:

• policy_id (str | None)

• payment_amount (float | int | None)

• contact_id (str | None)

• payment_method_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.make_payment_by_invoice_or_policy(payment_date=None, policy_number=None, amount=None, meta=None, payment_transaction_id=None, source_id=None, invoice_number=None, **kwargs)

Make a payment identified by invoice number or policy number..

POST /api/v2/payments/make_payment_by_invoice_or_policy

Parameters:

• payment_date (str | None)

• policy_number (str | None)

• amount (float | int | None)

• meta (dict[str, Any] | None)

• payment_transaction_id (str | None)

• source_id (str | None)

• invoice_number (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.mark_payment_nsf(payment_date=None, confirmation_number=None, policy_number=None, amount=None, disable_auto_pay=None, invoice_number=None, **kwargs)

Mark a payment as NSF..

POST /api/v2/payments/mark_payment_nsf

Parameters:

• payment_date (str | None)

• confirmation_number (str | None)

• policy_number (str | None)

• amount (float | int | None)

• disable_auto_pay (bool | None)

• invoice_number (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.remove_payment_method(payment_method_id=None, **kwargs)

Soft-delete a stored payment method..

POST /api/v2/payments/remove_payment_method

Parameters:

• payment_method_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_account_payoff_amount(policy_number=None, **kwargs)

Retrieve the payoff amount for an account or policy..

POST /api/v2/payments/retrieve_account_payoff_amount

Parameters:

• policy_number (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_convenience_fee(payment_amount=None, account_type=None, **kwargs)

Retrieve the processor convenience fee for a payment..

POST /api/v2/payments/retrieve_convenience_fee

Parameters:

• payment_amount (float | int | None)

• account_type (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_payment(payment_id=None, **kwargs)

Retrieve a specific payment record.

Provide payment_id for the payment that should be fetched. Returns the normalized process_result(...) payload, and **kwargs may include RequestParameters overrides.

Parameters:

• payment_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_payment_batch_entries(batch_id=None, **kwargs)

Retrieve the entries related to a payment batch..

POST /api/v2/payments/retrieve_payment_batch_entries

Parameters:

• batch_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_payment_batches(load_entries=None, **kwargs)

Retrieve payment batch records..

POST /api/v2/payments/retrieve_payment_batches

Parameters:

• load_entries (bool | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_payment_entries(entry_ids=None, **kwargs)

Retrieve payment entries by entry identifier.

Provide entry_ids for the entry records that should be returned. Returns the normalized process_result(...) payload, and **kwargs accepts RequestParameters overrides.

Parameters:

• entry_ids (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_payment_methods(contact_ids=None, exp_less_than=None, **kwargs)

Retrieve payment methods for one or more contacts..

POST /api/v2/payments/retrieve_payment_methods

Parameters:

• contact_ids (list[str] | None)

• exp_less_than (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_policy_billing_information(policy_term_id=None, billing_only=None, policy_id=None, **kwargs)

Retrieve billing information for a policy..

POST /api/v2/payments/retrieve_policy_billing_information

Parameters:

• policy_term_id (str | None)

• billing_only (bool | None)

• policy_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_sweep_payment_list(procdate=None, **kwargs)

Retrieve pending sweep payments..

POST /api/v2/payments/retrieve_sweep_payment_list

Parameters:

• procdate (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_updated_invoice_balance(invoice_id=None, **kwargs)

Retrieve the current balance for an invoice..

POST /api/v2/payments/retrieve_updated_invoice_balance

Parameters:

• invoice_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.update_payment_batch(batch_id=None, data=None, **kwargs)

Update a payment batch record..

POST /api/v2/payments/update_payment_batch

Parameters:

• batch_id (str | None)

• data (dict[str, Any] | list[dict[str, Any]] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.update_payment_entries(entries=None, **kwargs)

Update payment entries from a serialized dataset..

POST /api/v2/payments/update_payment_entries

Parameters:

• entries (list[dict[str, Any]] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.update_sweep_payments_complete(procdate=None, payment_ids=None, **kwargs)

Mark sweep payments as completed..

POST /api/v2/payments/update_sweep_payments_complete

Parameters:

• procdate (str | None)

• payment_ids (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.approve_pending_payment(payment_id=None, settlement_date_time=None, integration_instance_external_id=None, reference_id=None, set_reference_id=None, vendor_processing_fee_in_cents=None, **kwargs)

Approve Pending Payment.

POST /api/v2/payments/approve_pending_payment

Parameters:

• payment_id (str | Any | None)

• settlement_date_time (str | Any | None)

• integration_instance_external_id (str | None)

• reference_id (str | Any | None)

• set_reference_id (str | Any | None)

• vendor_processing_fee_in_cents (int | Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.create_recurring_payment_consent(contact_id=None, **kwargs)

Create Recurring Payment Consent.

POST /api/v2/payments/create_recurring_payment_consent

Parameters:

• contact_id (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.decline_pending_payment(payment_id=None, vendor_message=None, integration_instance_external_id=None, reference_id=None, **kwargs)

Decline Pending Payment.

POST /api/v2/payments/decline_pending_payment

Parameters:

• payment_id (str | Any | None)

• vendor_message (str | None)

• integration_instance_external_id (str | None)

• reference_id (str | Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.import_payment_method(policy_term_external_system_reference=None, vendor_payment_method_id=None, payment_method_type=None, contact_external_system_reference=None, contact_id=None, policy_term_id=None, vendor_customer_id=None, **kwargs)

Import Payment Method.

POST /api/v2/payments/import_payment_method

Parameters:

• policy_term_external_system_reference (str | None)

• vendor_payment_method_id (str | None)

• payment_method_type (str | None)

• contact_external_system_reference (str | None)

• contact_id (str | None)

• policy_term_id (str | None)

• vendor_customer_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_active_payment_processor(**kwargs)

Retrieve Active Payment Processor.

POST /api/v2/payments/retrieve_active_payment_processor

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_payment_method_consent(payment_method_id=None, **kwargs)

Retrieve Payment Method Consent.

POST /api/v2/payments/retrieve_payment_method_consent

Parameters:

• payment_method_id (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_payment_method_creation_details(contact_id=None, requester_contact_id=None, cancel_url=None, success_url=None, policy_ids=None, types=None, **kwargs)

Retrieve Payment Method Creation Details.

POST /api/v2/payments/retrieve_payment_method_creation_details

Parameters:

• contact_id (str | None)

• requester_contact_id (str | None)

• cancel_url (str | None)

• success_url (str | None)

• policy_ids (list[str] | None)

• types (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.retrieve_pending_payments_for_settlement(integration_instance_external_id=None, **kwargs)

Retrieve Pending Payments For Settlement.

POST /api/v2/payments/retrieve_pending_payments_for_settlement

Parameters:

• integration_instance_external_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.settle_payments(payments=None, **kwargs)

Settle Payments.

POST /api/v2/payments/settle_payments

Parameters:

• payments (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.store_external_payment(transaction_date_time=None, external_account_name=None, transaction_amount_in_cents=None, policy_number=None, **kwargs)

Store External Payment.

POST /api/v2/payments/store_external_payment

Parameters:

• transaction_date_time (str | None)

• external_account_name (str | None)

• transaction_amount_in_cents (int | None)

• policy_number (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.store_payment(policy_numbers=None, transaction_amount_in_cents=None, vendor_response=None, masked_number=None, integration_instance_external_id=None, convenience_fee_in_cents=None, transaction_date_time=None, reference_id=None, vendor_message=None, pay_by=None, account_name=None, vendor_processing_fee_in_cents=None, **kwargs)

Store Payment.

POST /api/v2/payments/store_payment

Parameters:

• policy_numbers (list[str] | None)

• transaction_amount_in_cents (int | None)

• vendor_response (dict[str, Any] | None)

• masked_number (str | None)

• integration_instance_external_id (str | None)

• convenience_fee_in_cents (int | None)

• transaction_date_time (str | None)

• reference_id (str | None)

• vendor_message (str | None)

• pay_by (str | None)

• account_name (str | None)

• vendor_processing_fee_in_cents (int | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.payments.store_payment_nsf(payment_id=None, policy_term_external_system_reference=None, postpone_until_date=None, allow_cancel=None, assess_fee=None, policy_term_id=None, policy_id=None, **kwargs)

Store Payment Nsf.

POST /api/v2/payments/store_payment_nsf

Parameters:

• payment_id (str | None)

• policy_term_external_system_reference (str | None)

• postpone_until_date (str | None)

• allow_cancel (bool | None)

• assess_fee (str | None)

• policy_term_id (str | None)

• policy_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any