Payments REST Endpoints

Sort by

Task Path Method

Order Management/Channel Customer Claims/Settlement Methods/Settlement Documents/Payments

A sum of money paid, for example, by check or credit memo to settle a claim, which can be viewed and updated.

Create payment documents

Method: post

Path: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}/child/settlementDocuments/{SettlementDocumentId}/child/payments

Delete one payment document

Method: delete

Path: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}/child/settlementDocuments/{SettlementDocumentId}/child/payments/{PaymentId}

Get all payment documents

Method: get

Path: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}/child/settlementDocuments/{SettlementDocumentId}/child/payments

Get one payment document

Method: get

Path: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}/child/settlementDocuments/{SettlementDocumentId}/child/payments/{PaymentId}

Update one payment document

Method: patch

Path: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}/child/settlementDocuments/{SettlementDocumentId}/child/payments/{PaymentId}