Records an external payment against multiple invoices.
To apply a payment to multiple invoices, at minimum, specify the amount and applications (i.e., invoice_uid and amount) details.
{ "payment": { "memo": "to pay the bills", "details": "check number 8675309", "method": "check", "amount": "250.00", "applications": [ { "invoice_uid": "inv_8gk5bwkct3gqt", "amount": "100.00" }, { "invoice_uid": "inv_7bc6bwkct3lyt", "amount": "150.00" } ] }}Note that the invoice payment amounts must be greater than 0. Total amount must be greater or equal to invoices payment amount sum.
The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
curl -X POST \ --url 'https://subdomain.chargify.com/invoices/payments.json' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "payment": { "memo": "to pay the bills", "details": "check number 8675309", "method": "check", "amount": "100.00", "applications": [ { "invoice_uid": "inv_8gk5bwkct3gqt", "amount": "50.00" }, { "invoice_uid": "inv_7bc6bwkct3lyt", "amount": "50.00" } ] }}'