Payment Service API REST Endpoints

Sort by

Task Path Method

Instruments Receivables Services/Payment Service API

This service provides APIs to perform operations on Payment Transactions.

Authorize the payment transaction

Method: post

Path: /service/v1/authorizePayment

Create the excess payment for a reconciliation transaction

Method: post

Path: /service/v1/checkForExcessPayment

Create the new payment in stage table

Method: post

Path: /service/v1/stagePayment

Create the payment transactions

Method: post

Path: /service/v1/payments

Fetch the excess payment handling parameters

Method: get

Path: /service/v1/getExcessHandlingParameters

Fetch the excess payment transaction details

Method: get

Path: /service/v1/excessPaymentInq

Fetch the payment transaction details from work table

Method: get

Path: /service/v1/paymentTwSearchByNumber

Fetch the payment transactions

Method: get

Path: /service/v1/paymentSearch

Fetch the payment transactions from main table on the basis of Payment Reference Number

Method: get

Path: /service/v1/getPaymentByPayRefNo

Fetch the payment transactions from work table

Method: get

Path: /service/v1/paymentTwSearch

Fetch the payment transactions from work table on the basis of Payment Reference Number

Method: get

Path: /service/v1/getPaymentTwByPayRefNo

Fetch the payment transactions which are in processing state

Method: get

Path: /service/v1/getCurrentTwPayment

Post the payments from the stage to the main table after validation

Method: post

Path: /service/v1/mainPayment

Purge the payment transactions

Method: post

Path: /service/v1/purgePmtTransaction

Roll-back the amount and status for payment and credit note

Method: post

Path: /service/v1/purgeInstrumentsRecon

Update the payment data after invoice payment reconciliation

Method: patch

Path: /service/v1/invPayRecon

Update the payment status after allocation

Method: post

Path: /service/v1/allocationStatus