EIPP
EIPP (electronic invoice presentment and payment) can help your customers streamline their payment by improving the efficiency and security to manage their invoices, process payments and cash flow.
The key features of EIPP include:
- Electronic Invoice Delivery: manage invoice information electronically
- Automated Payment Processing: Process payments securely and efficiently through our API
- Scalability: Handle high volumes of invoices and payments with ease
- Integration: Easily integrate with existing accounting and ERP systems
- The EIPP information is an extension of our Order API. Please refer to the Order documentation for more detailed information on other fields.
How to use Charge EIPP API?
The batch_payment_details field allows for the breakdown of a total order amount into multiple payment entries.
This is useful in cases where an invoice is settled in parts or where multiple transactions correspond to a single order.
Each entry in batch_payment_details represents a separate payment installment associated with unique metadata.
Endpoint
/order_token
Payload
{
"order_request": {
...OtherOrderFields,
"batch_payment_details": [{
"amount": {
"value": 2500
},
"extra_fields": [{
"key": "invoiceNumber",
"value": "#8787789"
}]
},
{
"amount": {
"value": 2500
},
"extra_fields": [{
"key": "invoiceNumber",
"value": "#8787789-1"
}]
}
]
}
}
| Field | Type | Description |
|---|---|---|
amount | Object | Represents the monetary value for this specific payment installment. |
amount.value | Number | The value of this specific payment installment (e.g., 2500). |
extra_fields | Array | Array of key-value pairs for additional metadata associated with each payment installment. |
extra_fields.key | String | A key representing metadata for the payment. For instance, "invoiceNumber" is used to specify the invoice number.
There is no specific validation for this one and it is totally up to merchants to use their desired key/values. |
extra_fields.value | String | The value associated with the key (e.g., "#8787789"). There is no specific validation for this one and it is totally up to merchants to use their desired key/values. |
Here’s a dedicated section on Settlements for the documentation:
Settlements
The Settlement process in the Charge API finalizes and records the payments made for an order, allowing merchants to reconcile received funds with their internal records. During settlement, all entries in batch_payment_details—including metadata in extra_fields—are exported and made available to the merchant. This enables efficient and accurate tracking of each payment installment associated with an order.
Key Features of Settlement
-
Export of Extra Fields: Every
extra_fieldsentry included in thebatch_payment_detailssection is exported during settlement. This data includes key-value pairs for specific identifiers (e.g., invoice numbers, order references) that the merchant can use for internal reconciliation. -
Reconciliation-Ready: With the export of
extra_fields, merchants can easily match incoming funds with individual payment details, enabling a seamless reconciliation process. Unique identifiers likeinvoiceNumberinextra_fieldsprovide precise tracking for each payment installment.