# PaymentSearchInput

Input · GraphQL API

Input fields for searching for any type of Payment.

## Fields

- `id` (`SearchValueInput`): Find payments with an ID or IDs.
- `type` (`SearchPaymentTypeInput`): Find payments by their type. Use this field to search for payments by the direction of money movement.
- `status` (`SearchPaymentStatusInput`): Find payments with a given status.
- `statusTransition` (`SearchPaymentStatusTransitionInput`): Find payments based on the time at which they transitioned to a given status.
- `createdAt` (`SearchTimestampInput`): Find payments based on the time they were created.
- `amount` (`MonetaryAmountSearchInput`): Find payments for a given amount or currency.
- `orderId` (`SearchTextInput`): Find payments with a given orderId.
- `merchantAccountId` (`SearchPaymentMerchantAccountIdInput`): Find payments processed through a merchant account ID or IDs.
- `customer` (`SearchPaymentCustomerInput`): Find payments with a given customer.
- `disbursementDate` (`SearchDateInput`): Find payments by their disbursement date. Only use this search criteria if you have an eligible merchant account. Note that payments can only be disbursed after they reach the SETTLED status.
- `source` (`SearchPaymentSourceInput`): Find payments created with a given source.
- `settlementBatchId` (`SearchTextInput`): Find payments by the batch ID under which the payment was submitted for settlement.
- `paymentMethod` (`SearchPaymentPaymentMethodInput`): Find payments based on information about the payment method used for the payment.
- `facilitatorOAuthApplicationClientId` (`SearchValueInput`): Find payments created by a third party via the Grant API using a given OAuth application client ID.
- `userId` (`SearchValueInput`): Find payments with a user ID or IDs.
- `storeId` (`SearchValueInput`): Find payments by the ID of the store that the transaction was processed in.
- `readerId` (`SearchValueInput`): Find payments by the reader ID.
- `shippingAddress` (`SearchAddressInput`): Find payments by the shipping address.
- `billingAddress` (`SearchAddressInput`): Find payments by the billing address.
- `disputeReceivedDate` (`SearchDateInput`): Find payments by dispute received date.
- `processorAuthorizationId` (`SearchTextInput`): Find payments by the processor authorization code.
- `processingMode` (`SearchProcessingModeInput`): Find payments by the processing mode.

## Used by

- [payments](/braintree/graphql/reference/queries/payments) — Query; input
- [Search](/braintree/graphql/reference/types/search) — Object; payments(input)

## GraphQL definition

```graphql
input PaymentSearchInput {
  id: SearchValueInput
  type: SearchPaymentTypeInput
  status: SearchPaymentStatusInput
  statusTransition: SearchPaymentStatusTransitionInput
  createdAt: SearchTimestampInput
  amount: MonetaryAmountSearchInput
  orderId: SearchTextInput
  merchantAccountId: SearchPaymentMerchantAccountIdInput
  customer: SearchPaymentCustomerInput
  disbursementDate: SearchDateInput
  source: SearchPaymentSourceInput
  settlementBatchId: SearchTextInput
  paymentMethod: SearchPaymentPaymentMethodInput
  facilitatorOAuthApplicationClientId: SearchValueInput
  userId: SearchValueInput
  storeId: SearchValueInput
  readerId: SearchValueInput
  shippingAddress: SearchAddressInput
  billingAddress: SearchAddressInput
  disputeReceivedDate: SearchDateInput
  processorAuthorizationId: SearchTextInput
  processingMode: SearchProcessingModeInput
}
```

---

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