Record payment
POST
apiKeyheader
AuthorizationBearer <token>An API key (blk_…) from Settings → API keys.
invoiceId*stringapplication/json- body
amount*integerRange
0 < value <= 9007199254740991paidOn?stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
datemethod?stringDefault
"bank_transfer"Value in
"bank_transfer""mobile_wallet""card""cash""cheque""online""other"reference?|Length
length <= 200notes?|Length
length <= 2000application/json- response
id*stringinvoiceId*stringinvoiceNumber*string|nullclientId*stringclientName*stringamount*integerRange
-9007199254740991 <= value <= 9007199254740991currency*stringpaidOn*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
datemethod*stringValue in
"bank_transfer""mobile_wallet""card""cash""cheque""online""other"reference*string|nullnotes*string|nullstatus*stringValue in
"completed""refunded"refundedAt*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timerefundReason*string|nullreceiptId*string|nullreceiptNumber*string|nullreceiptLastSentAt*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timecreatedAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timecurl -X POST 'https://your-billleaf-api/v1/invoices/string/payments' \ -H 'Content-Type: application/json' \ -d '{ "amount": 1}'Example Response201
{ "id": "string", "invoiceId": "string", "invoiceNumber": "string", "clientId": "string", "clientName": "string", "amount": -9007199254740991, "currency": "string", "paidOn": "2019-08-24", "method": "bank_transfer", "reference": "string", "notes": "string", "status": "completed", "refundedAt": "2019-08-24T14:15:22Z", "refundReason": "string", "receiptId": "string", "receiptNumber": "string", "receiptLastSentAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z"}