Payment Status
https://publicschema.org/vocab/payment-status
The processing states of a payment event in the disbursement cycle.
Values
| Code | Label | Standard code | Definition |
|---|---|---|---|
pending | Pending | The payment has been scheduled or initiated but has not yet been transmitted or confirmed. | |
processing | Processing | The payment instruction has been accepted by the financial intermediary and is being executed. | |
partial | Partial | Part of the payment amount has been transmitted but the full amount has not yet been delivered. | |
paid | Paid | The payment has been successfully transmitted and received by the beneficiary. | |
failed | Failed | The payment attempt did not complete successfully due to a technical or account-level error. | |
returned | Returned | The payment was transmitted but subsequently returned by the receiving institution or agent. | |
rejected | Rejected | The payment was evaluated and denied based on a business or policy decision, such as a failed eligibility check or a disputed claim. | |
cancelled | Cancelled | The payment was cancelled before transmission, typically due to eligibility changes or administrative decision. |
System mappings
OpenSPP
| System code | System label | payment-status value |
|---|---|---|
issued | Issued | pending |
sent | Sent | processing |
reconciled | Reconciled | paid |
paid | Paid | paid |
failed | Failed | failed |
notpaid | Not Paid | pending |
Not covered by OpenSPP: partial, returned, cancelled, rejected
FHIR R4
System vocabulary: PaymentStatusCodes
| System code | System label | payment-status value |
|---|---|---|
paid | Paid | paid |
cleared | Cleared | paid |
Not covered by FHIR R4: partial, pending, failed, returned, cancelled, processing, rejected
OpenCRVS
System vocabulary: PaymentOutcomeType
| System code | System label | payment-status value |
|---|---|---|
COMPLETED | Completed | paid |
ERROR | Error | failed |
PARTIAL | Partial | partial |
Not covered by OpenCRVS: pending, returned, cancelled, processing, rejected
openIMIS
System vocabulary: BenefitConsumptionStatus
| System code | System label | payment-status value |
|---|---|---|
CREATED | Created | pending |
ACCEPTED | Accepted | processing |
APPROVE_FOR_PAYMENT | Approve For Payment | processing |
REJECTED | Rejected | rejected |
DUPLICATE | Duplicate | cancelled |
PENDING_DELETION | Pending Deletion | cancelled |
RECONCILED | Reconciled | paid |
Not covered by openIMIS: partial, paid, failed, returned
GovStack Payments BB
System vocabulary: BatchTransactionStatus (implied)
| System code | System label | payment-status value |
|---|---|---|
ongoing | Ongoing | processing |
completed | Completed | paid |
failed | Failed | failed |
Not covered by GovStack Payments BB: partial, pending, returned, rejected, cancelled
Referenced by this vocabulary
- GovStack Payments GovStack (ITU, GIZ, DIAL, Estonia)
- ISO 20022 PaymentStatus ISO 20022 Registration Management Group
- Mojaloop FSPIOP Mojaloop Foundation
Other references
- ISO 20022 ExternalPaymentTransactionStatus1Code superset ISO 20022 defines granular interbank processing states. This vocabulary is a deliberate high-level simplification.
- Mojaloop FSPIOP TransferState partial overlap
Help improve this page
Highlight any text on this page to leave an annotation. Join our review group to get started.
If you have a GitHub account, click the feedback icon next to any section heading to report a specific issue.