Payment Management Microservice
  • Dark
    Light
  • PDF

Payment Management Microservice

  • Dark
    Light
  • PDF

Payments are easily managed via multiple channels via the usage of these APIs.


APIs

addPaymentMethod

The purpose of the addPaymentMethod API is to create a new payment mean on a customer account, in order to satisfy the caller's request.

applyPayment

The purpose of the applyPayment API is to register a customer payment to a customer account.

approveRefund

The purpose of the approveRefund API is to approve the specified customer refund.

createCustomerDeposit

The purpose of the createCustomerDeposit API is to create customer deposit.

createCustomerRefund

The purpose of the createCustomerRefund API is to create the customer refund.

customerPaymentDelete

The purpose of the customerPaymentDelete API is to delete an existing customer payment.

customerPaymentGet

The purpose of the customerPaymentGet API is to fetch the customer account payment invoices information based on filters passed on query parameter.

customerPaymentsFind

The purpose of the customerPaymentsFind API is to fetch the customer account payment invoices information based on the filters passed on query parameter.

customerPaymentsReverse

The purpose of the customerPaymentsReverse API is to reverse the payment used to reverse billed/applied payment.

customerPaymentsTransfer

The purpose of the customerPaymentsTransfer API is to transfer the payment used to transfer the billed/applied payment.

customerPaymentUpdate

The purpose of the customerPaymentUpdate API is to update a payment on a customer account.

deactivatePaymentMethod

The purpose of the deactivatePaymentMethod API is to deactivate a payment means on a customer account, in order to satisfy the caller's request.

denyRefund

The purpose of the denyRefund API is to deny the specified customer refund.

fieldTokens

The purpose of the fieldTokens API is to fetch the refunds data based on the filters passed as a query parameter outside of the customer account context.

findCustomerDeposits

The purpose of the findCustomerDeposits API is to fetch the customer deposits data based on filters passed as a query parameter.

findCustomerRefunds

The purpose of the findCustomerRefunds API is to fetch the customer refunds data based on the filters passed as a query parameter.

findRefunds

The purpose of the findRefunds API is to fetch refunds data based on the filters passed as a query parameter outside of customer account context.

getAccountPaymentMethods

The purpose of the getAccountPaymentMethods API is to retrieve a payment mean on a customer account, in order to satisfy the caller's request.

getCustomerDeposit

The purpose of the getCustomerDeposit API is to fetch the deposit record information.

getCustomerRefund

The purpose of the getCustomerRefund API is to fetch the specified customer refund data based on the identifier passed as a path parameter.

getPartialPaymentMethod

The purpose of the getPartialPaymentMethod API is to integration with rule engine to retrieve if partial payment is allowed. In addition, API pass through Rule Engine. Rule Engine project: partialPayment.

getPaymentMethod

The purpose of the getPaymentMethod API is to retrieve a payment mean on a customer account, in order to satisfy the caller's request.

getPaymentMethodExpire

The purpose of the getPaymentMethodExpire API is to check if the customer's default payment profile is going to expire.

performTransactions

The purpose of the performTransactions API is to perform transactions.

returnCustomerDeposit

The purpose of returnCustomerDeposit API is to return customer deposit. If refund Type {1=check, 2=credit card,3=direct debit} provided, it will create deposit payment record to refund deposit.

updatePaymentMethod

The purpose of the updatePaymentMethod API is to update a payment mean on a customer account, in order to satisfy the caller's request.

Discover how we can help your Business

Get in touch with us today


Was this article helpful?