Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Payment Collection

Retrieve Invoices

Retrive and filter invoices

get/api/v1/invoices/{id}/

Path parameters

idstring required

A unique string value identifying this invoices.

Response

invoice_idstring required
state'PENDING' | 'PROCESSING' | 'FAILED' | 'CANCELED' | 'PARTIAL' | 'COMPLETE' | 'RETRY'
  • PENDING - PENDING
  • PROCESSING - PROCESSING
  • FAILED - FAILED
  • CANCELED - CANCELED
  • PARTIAL - PARTIAL
  • COMPLETE - COMPLETE
  • RETRY - RETRY
provider'M-PESA' | 'PESALINK' | 'CARD-PAYMENT' | 'GOOGLE-PAY' | 'APPLE-PAY' | 'BITCOIN' | 'BANK-ACH' | 'COOP_B2B' required
  • M-PESA - M-Pesa
  • PESALINK - PesaLink(Bank KE)
  • CARD-PAYMENT - Card
  • GOOGLE-PAY - Google pay
  • APPLE-PAY - Apple pay
  • BITCOIN - Bitcoin
  • BANK-ACH - Bank ACH
  • COOP_B2B - COOP-Bank Agent
chargesstring decimal
net_amountstring required
currencystring required
valuestring decimal required
accountstring nullable

Depositing account, email or phone number

api_refstring nullable

API tracking reference number

clearing_statusstring required
mpesa_referencestring required
hoststring nullable

Payment origin host i.e domain making the payment

card_infostring required
retry_countinteger
failed_reasonstring nullable
failed_codestring nullable
failed_code_linkstring required
created_atstring date-time nullable required
updated_atstring date-time nullable required