Paying a single installment on a pledge invoice
The following details how to pay for a single installment on an installment pledge invoice. Multiple installments can be paid for using the same format for the payment.
To find the scheduled payment objects that are used for installment payments, an invoice can be found doing a GET request like this:
/api/Invoice?InvoiceId=10938
{
"$type": "Asi.Soa.Commerce.DataContracts.LegacyInvoiceData, Asi.Contracts",
"LockedEffectiveDate": "0001-01-01T00:00:00",
"Lines": {
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceLineDataCollection, Asi.Contracts",
"$values": []
},
"AdditionalCharges": {
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceAdditionalChargeDataCollection, Asi.Contracts",
"$values": []
},
"ScheduledPayments": {
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10938",
"PaymentNumber": 1,
"DueDate": "2025-09-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10939",
"PaymentNumber": 2,
"DueDate": "2025-10-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10940",
"PaymentNumber": 3,
"DueDate": "2025-11-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10941",
"PaymentNumber": 4,
"DueDate": "2025-12-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10942",
"PaymentNumber": 5,
"DueDate": "2026-01-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10943",
"PaymentNumber": 6,
"DueDate": "2026-02-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10944",
"PaymentNumber": 7,
"DueDate": "2026-03-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10945",
"PaymentNumber": 8,
"DueDate": "2026-04-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10946",
"PaymentNumber": 9,
"DueDate": "2026-05-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10947",
"PaymentNumber": 10,
"DueDate": "2026-06-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10948",
"PaymentNumber": 11,
"DueDate": "2026-07-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10949",
"PaymentNumber": 12,
"DueDate": "2026-08-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
}
]
},
"InvoiceId": "10938",
"FinancialEntity": {
"$type": "Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts",
"FinancialEntityId": "MARSH",
"Name": "Marshland Restoration Fund",
"EntityCode": "MARSH"
},
"InvoiceNumber": "R10949",
"InvoiceDate": "2025-09-11T00:00:00",
"BillToParty": {
"$type": "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts",
"CityName": "",
"CountryName": "",
"CountrySubEntityName": "",
"Email": "",
"Phone": "",
"PartyId": "23476",
"Id": "23476",
"UniformId": "8919a6e0-af92-44f8-a659-d04dc21f38cc",
"Status": {
"$type": "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts",
"PartyStatusId": "A",
"Name": "Active",
"Description": "Active"
},
"Name": "Installment Tester",
"Sort": "TESTER, INSTALLMENT",
"IsMarkedForDelete": false
},
"SoldToParty": {
"$type": "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts",
"CityName": "",
"CountryName": "",
"CountrySubEntityName": "",
"Email": "",
"Phone": "",
"PartyId": "23476",
"Id": "23476",
"UniformId": "8919a6e0-af92-44f8-a659-d04dc21f38cc",
"Status": {
"$type": "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts",
"PartyStatusId": "A",
"Name": "Active",
"Description": "Active"
},
"Name": "Installment Tester",
"Sort": "TESTER, INSTALLMENT",
"IsMarkedForDelete": false
},
"Description": "Help to restore marshlands and fresh water habitats - Pledge due Oct 11 2025",
"InvoicePurpose": 11,
"InvoiceAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 120.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"OriginalInvoiceAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 120.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"PaymentAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"PendingPaymentAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"AdjustmentAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 110.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"PreviousBalance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"AccountingMethod": 1,
"AdditionalAttributes": {
"$type": "Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts",
"Name": "SourceSystem",
"Value": "FR"
}
]
},
"InvoiceKey": "30351ff0-1095-4739-b070-1fc8cd1b85c6",
"DiscountCode": "",
"DiscountTotal": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"UndiscountedTotal": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 120.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"Note": ""
}
In the invoice data, the key information is the scheduled payment details, which represent each installment payment.
{
"$type": "Asi.Soa.Commerce.DataContracts.ScheduledPaymentData, Asi.Contracts",
"ScheduledPaymentId": "8539:10939",
"PaymentNumber": 2,
"DueDate": "2025-10-11T00:00:00",
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10.0000,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
}
},
Payment applications can now be added to the cart, allowing the amount paid on an installment to be updated when the cart is paid.
Within the Payments object, add RemittanceData entries to the RemittanceDataCollection. These entries should include the invoice ID and the remittance application ID (ScheduledPaymentId) that the payment will be applied to.
Note that the payment application amount cannot exceed the remaining balance of the scheduled payment. The InvoiceLineId is not used for installment payment applications.
{
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceApplicationData, Asi.Contracts",
"RemittanceApplicationId": "8539:10939",
"ApplicationAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"InvoiceId": "10938",
"DoNotReceipt": false
}
The Payments object will look like this:
"Payments": {
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceData, Asi.Contracts",
"PaymentToken": {
"$type": "Asi.Soa.Commerce.DataContracts.AutoPayAccountData, Asi.Contracts",
"PaymentMethodIsReadOnly": false
},
"Applications": {
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceApplicationDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceApplicationData, Asi.Contracts",
"RemittanceApplicationId": "8539:10939",
"ApplicationAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"InvoiceId": "10938",
"DoNotReceipt": false
},
]
}
}
]
}
The end-cart result will look like this before submitting:
{
"$type": "Asi.Soa.Commerce.DataContracts.CartData, Asi.Contracts",
"CartId": "22008870-6528-49b4-9188-3efb59bf6718",
"UserId": "23476",
"ComboOrder": {
"$type": "Asi.Soa.Commerce.DataContracts.ComboOrderData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"Invoices": {
"$type": "Asi.Soa.Commerce.DataContracts.InvoiceSummaryDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.LegacyInvoiceSummaryData, Asi.Contracts",
"LockedEffectiveDate": "0001-01-01T00:00:00",
"InvoiceId": "10938",
"FinancialEntity": {
"$type": "Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts",
"FinancialEntityId": "MARSH",
"Name": "Marshland Restoration Fund",
"EntityCode": "MARSH"
},
"InvoiceNumber": "R10949",
"InvoiceDate": "2025-09-11T00:00:00",
"DueDate": "2025-10-11T00:00:00",
"BillToParty": {
"$type": "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts",
"CityName": "",
"CountryName": "",
"CountrySubEntityName": "",
"Email": "",
"Phone": "",
"PartyId": "23476",
"Id": "23476",
"UniformId": "8919a6e0-af92-44f8-a659-d04dc21f38cc",
"Status": {
"$type": "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts",
"PartyStatusId": "A",
"Name": "Active",
"Description": "Active"
},
"Name": "Installment Tester",
"Sort": "TESTER, INSTALLMENT",
"IsMarkedForDelete": false
},
"SoldToParty": {
"$type": "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts",
"CityName": "",
"CountryName": "",
"CountrySubEntityName": "",
"Email": "",
"Phone": "",
"PartyId": "23476",
"Id": "23476",
"UniformId": "8919a6e0-af92-44f8-a659-d04dc21f38cc",
"Status": {
"$type": "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts",
"PartyStatusId": "A",
"Name": "Active",
"Description": "Active"
},
"Name": "Installment Tester",
"Sort": "TESTER, INSTALLMENT",
"IsMarkedForDelete": false
},
"Description": "Help to restore marshlands and fresh water habitats - Pledge due Oct 11 2025",
"InvoicePurpose": 11,
"InvoiceAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 120,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"OriginalInvoiceAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 120,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"PaymentAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"PendingPaymentAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"AdjustmentAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"Balance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 110,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"PreviousBalance": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"AccountingMethod": 1,
"AdditionalAttributes": {
"$type": "Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts",
"Name": "SourceSystem",
"Value": "FR"
}
]
},
"InvoiceKey": "30351ff0-1095-4739-b070-1fc8cd1b85c6",
"Note": ""
}
]
},
"Payments": {
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceData, Asi.Contracts",
"PaymentToken": {
"$type": "Asi.Soa.Commerce.DataContracts.AutoPayAccountData, Asi.Contracts",
"PaymentMethodIsReadOnly": false
},
"Applications": {
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceApplicationDataCollection, Asi.Contracts",
"$values": [
{
"$type": "Asi.Soa.Commerce.DataContracts.RemittanceApplicationData, Asi.Contracts",
"RemittanceApplicationId": "8539:10939",
"ApplicationAmount": {
"$type": "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts",
"Amount": 10,
"Currency": {
"$type": "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts",
"CurrencyCode": "USD",
"DecimalPositions": 2
},
"IsAmountDefined": true
},
"InvoiceId": "10938",
"DoNotReceipt": false
}
]
}
}
]
},
"OrderTypeCode": "INV"
},
"UpdateInformation": {
"$type": "Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts",
"CreatedBy": "23202",
"CreatedOn": "2025-09-11T18:01:31.127",
"UpdatedBy": "23202",
"UpdatedOn": "2025-09-11T18:16:27.54"
}
}
Updated about 16 hours ago