# PaymentStatus

Enum · GraphQL API

The status of the payment, indicating its success or failure, and where it is in its [lifecycle](https://articles.braintreepayments.com/get-started/transaction-lifecycle). For further details on why any given status occurred, consult the corresponding `PaymentStatusEvent` in the payment's `statusHistory`.

## Values

- `AUTHORIZATION_EXPIRED`: The transaction spent too much time in the `AUTHORIZED` status and was marked as expired. Expiration [time frames](https://developers.braintreepayments.com/reference/general/statuses#authorization-expired) differ by card type, transaction type, and, in some cases, merchant category.
- `AUTHORIZED`: The processor authorized the transaction, putting your customer's funds on hold. Your customer may see a pending charge on his or her account. However, before the customer is actually charged and before you receive the funds, you must use the `captureTransaction` mutation. If you do not want to capture the transaction, you should use the `reverseTransaction` mutation to avoid a misuse of authorization fee.
- `AUTHORIZING`: If a payment remains in a status of `AUTHORIZING`, [contact us for assistance](https://help.braintreepayments.com?issue=TransactionProcessingQuestion).
- `FAILED`: An error occurred when sending the payment to the downstream processor. See the payment's `statusHistory` for the exact error.
- `GATEWAY_REJECTED`: The transaction was [rejected](https://articles.braintreepayments.com/control-panel/transactions/gateway-rejections) based on one or more settings or rules in your Braintree gateway. See the transaction's `statusHistory` to determine which resulted in the decline.
- `PROCESSOR_DECLINED`: The processor declined the transaction while attempting to authorize it. See the transaction's `statusHistory` to determine what reason the processor gave for the decline.
- `SETTLED`: The payment has been settled. For transactions, this means your customer has been charged and the process of disbursing the funds to your bank account has begun. For refunds, it means that the process of disbursing funds back to the customer has begun.
- `SETTLEMENT_CONFIRMED`: The transaction was captured partially and will not be submitted to processor for settling. Its child transaction(s) has been successfully captured and will be included in the next settlement batch.
- `SETTLEMENT_DECLINED`: The processor declined the payment while attempting to capture it. See the payment's `statusHistory` to determine why it wasn't settled. This status is rare, and only certain types of transactions can be affected.
- `SETTLEMENT_PENDING`: The transaction has not yet fully settled. This status is rare, and will generally resolve to a status of `SETTLED`. Only certain types of transactions can be affected.
- `SETTLING`: The payment is in the process of being settled. This is a transitory state, and will resolve to a status of `SETTLED`.
- `SUBMITTED_FOR_SETTLEMENT`: The payment has been successfully captured, and will be included in the next settlement batch, at which time it will become settled.
- `VOIDED`: The payment has been voided or canceled. For transactions, this means it's no longer authorized, your customer's funds are no longer on hold, and you can't use the `captureTransaction` mutation on this transaction. For refunds, it means the customer will not receive the funds from the refund.

## Used by

- [AuthorizationExpiredEvent](/braintree/graphql/reference/types/authorization-expired-event) — Object; status
- [AuthorizedEvent](/braintree/graphql/reference/types/authorized-event) — Object; status
- [FailedEvent](/braintree/graphql/reference/types/failed-event) — Object; status
- [GatewayRejectedEvent](/braintree/graphql/reference/types/gateway-rejected-event) — Object; status
- [Payment](/braintree/graphql/reference/types/payment) — Interface; status
- [PaymentStatusEvent](/braintree/graphql/reference/types/payment-status-event) — Interface; status
- [ProcessorDeclinedEvent](/braintree/graphql/reference/types/processor-declined-event) — Object; status
- [Refund](/braintree/graphql/reference/types/refund) — Object; status
- [SearchPaymentStatusInput](/braintree/graphql/reference/types/search-payment-status-input) — Input; in
- [SearchTransactionStatusInput](/braintree/graphql/reference/types/search-transaction-status-input) — Input; in, is
- [SettledEvent](/braintree/graphql/reference/types/settled-event) — Object; status
- [SettlementConfirmedEvent](/braintree/graphql/reference/types/settlement-confirmed-event) — Object; status
- [SettlementDeclinedEvent](/braintree/graphql/reference/types/settlement-declined-event) — Object; status
- [SettlementPendingEvent](/braintree/graphql/reference/types/settlement-pending-event) — Object; status
- [SettlingEvent](/braintree/graphql/reference/types/settling-event) — Object; status
- [SubmittedForSettlementEvent](/braintree/graphql/reference/types/submitted-for-settlement-event) — Object; status
- [Transaction](/braintree/graphql/reference/types/transaction) — Object; status
- [VoidedEvent](/braintree/graphql/reference/types/voided-event) — Object; status

## GraphQL definition

```graphql
enum PaymentStatus {
  AUTHORIZATION_EXPIRED
  AUTHORIZED
  AUTHORIZING
  FAILED
  GATEWAY_REJECTED
  PROCESSOR_DECLINED
  SETTLED
  SETTLEMENT_CONFIRMED
  SETTLEMENT_DECLINED
  SETTLEMENT_PENDING
  SETTLING
  SUBMITTED_FOR_SETTLEMENT
  VOIDED
}
```

---

[View the complete GraphQL schema on GitHub](https://raw.githubusercontent.com/braintree/graphql-api/refs/heads/master/schema.graphql)