Skip to navigation
Dice Standardized APIs V2 CopyInvoice

Post Invoice Payment

View as Markdown

Post Invoice Payment

This API allows you to make an HTTP POST request to submit a payment for an invoice.

Request Body

The request should include the following parameters in the raw request body:

ParamRequiredTypeDescription
invoiceIdMandatoryStringThe ID of the invoice for which the payment is being submitted.
amountMandatoryNumberThe amount of the payment.
utrMandatoryStringThe Unique Transaction Reference for the payment.
payment_docMandatoryStringThe document related to the payment.
dataMandatoryObjectAdditional data related to the payment.

Response

Upon successful execution, the API will return a status code of 200 and a JSON response with a success key indicating whether the payment submission was successful.

Example Response

{
    "success": true
}

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret

Request

This endpoint expects an object.
invoiceIdstringRequired
amountintegerRequired
utrstringRequired
payment_docstringRequired
dataobjectRequired

Response

OK
successboolean