Stitch API Reference

https://docs.stitch.money/api
Admin
Stitch is a financial API platform that provides services for integrating various payment methods,...
Tokens:126,721
Snippets:1,645
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### UserInitiatePaymentInput GraphQL Schema

Source: https://docs.stitch.money/api/inputs/user-initiate-payment-input

Defines the input object structure for initiating payments.

```graphql
input UserInitiatePaymentInput {  
  amount: MoneyInput!  
  expireAt: Date  
  payerReference: String  
  beneficiaryReference: String  
  externalReference: String  
  merchant: String  
  payerInformation: PayerInformationInput  
}  
```

--------------------------------

### CapitecPayRecurringPaymentScheduleInput GraphQL Definition

Source: https://docs.stitch.money/api/inputs/capitec-pay-recurring-payment-schedule-input

The input object definition for recurring payment schedules, requiring a start date and a frequency enum.

```graphql
input CapitecPayRecurringPaymentScheduleInput {  
  start: Date!  
  frequency: CapitecPayRecurringFrequency!  
}  
```

--------------------------------

### CapitecPayRecurringPaymentSchedule GraphQL Type Definition

Source: https://docs.stitch.money/api/objects/capitec-pay-recurring-payment-schedule

Defines the schema structure for recurring payment schedules, requiring a start date and a frequency enum.

```graphql
type CapitecPayRecurringPaymentSchedule {  
  start: Date!  
  frequency: CapitecPayRecurringFrequency!  
}  
```

--------------------------------

### tenantClientCreate

Source: https://docs.stitch.money/api/mutations/tenant-client-create

Creates a new tenant client and returns the associated secret.

```APIDOC
## mutation tenantClientCreate

### Description
Creates a new tenant client and returns the associated secret. This operation requires the `[tenant_clientcreate]` scope.

### Signature
`tenantClientCreate(input: TenantClientCreateInput!): TenantClientCreatePayload!`

### Arguments
- **input** (TenantClientCreateInput!) - Required - The input object containing details for the new tenant client.

### Response
- **TenantClientCreatePayload** (object) - Returns the newly created tenant client and its associated secret.
```

--------------------------------

### Retrieve Bank Account Statement Document

Source: https://docs.stitch.money/api/objects/bank-account-statement

To download the actual statement file, perform an HTTP GET request to the URL provided in the downloadUrl field of the BankAccountStatement object.

```APIDOC
## GET [downloadUrl]

### Description
Make a HTTP GET request with the standard authorization header to the `downloadURL` to retrieve the document itself. This operation requires the `[bankstatements]` scope.

### Method
GET

### Endpoint
[downloadUrl]
```

--------------------------------

### tenantClientCreate

Source: https://docs.stitch.money/api/operations/mutations/tenant-client-create

Creates a new tenant client and returns the associated secret.

```APIDOC
## tenantClientCreate

### Description
Creates a new tenant client and its associated secret. This operation requires the `[tenant_clientcreate]` scope.

### Signature
`tenantClientCreate(input: TenantClientCreateInput!): TenantClientCreatePayload!`

### Arguments
- **input** (TenantClientCreateInput!) - Required - The input object containing details for the new tenant client.

### Return Type
- **TenantClientCreatePayload** (object) - The result object containing the created tenant client and its associated secret.
```

--------------------------------

### UserInitiatePaymentInput

Source: https://docs.stitch.money/api/types/inputs/user-initiate-payment-input

The UserInitiatePaymentInput object defines the required and optional fields for initiating a payment.

```APIDOC
## UserInitiatePaymentInput

### Description
Details required to initiate an authorized payment.

### Fields
- **amount** (MoneyInput!) - Required - The amount of the payment.
- **expireAt** (Date) - Optional - ISO 8061 date used to set an expiry on a payment.
- **payerReference** (String) - Optional - Reference that will appear on the user's statement.
- **beneficiaryReference** (String) - Optional - Reference that will appear on the beneficiary's statement.
- **externalReference** (String) - Optional - Reference field present with redirect query parameters upon completion.
- **merchant** (String) - Optional - The name or unique identifier for the merchant.
- **payerInformation** (PayerInformationInput) - Optional - KYC information for the payer.
```

--------------------------------

### BankAccountStatement Object

Source: https://docs.stitch.money/api/types/objects/bank-account-statement

The BankAccountStatement object contains details about a bank statement. To retrieve the actual document, perform an HTTP GET request to the provided downloadUrl using the required [bankstatements] scope.

```APIDOC
## BankAccountStatement Object

### Description
Represents a bank statement document. To download the file, make an HTTP GET request to the `downloadUrl` with the standard authorization header.

### Required Scope
`[bankstatements]`

### Fields
- **id** (ID!) - Unique identifier for the statement.
- **downloadUrl** (URL!) - The URL to download the statement document.
- **mimetype** (MimeType!) - The MIME type of the document.
- **filename** (String!) - The name of the file.
- **certified** (Boolean!) - Indicates if the statement has an official bank stamp.
- **startDate** (Date!) - The earliest date covered by the statement.
- **endDate** (Date!) - The latest date covered by the statement.
- **bankAccount** (BankAccount!) - The associated bank account.
```

--------------------------------

### userInitiatePayment

Source: https://docs.stitch.money/api/mutations/user-initiate-payment

Initiates an authorized payment using the provided input.

```APIDOC
## mutation userInitiatePayment

### Description
Initiates an authorized payment process.

### Signature
userInitiatePayment(input: UserInitiatePaymentInput!): UserInitiatePaymentPayload

### Arguments
- **input** (UserInitiatePaymentInput!) - Required - The input object containing payment details.

### Return Type
- **UserInitiatePaymentPayload** (object) - Response from an initiated authorized payment.
```

--------------------------------

### userInitiatePayment

Source: https://docs.stitch.money/api/operations/mutations/user-initiate-payment

Initiates an authorized payment using the provided input.

```APIDOC
## mutation userInitiatePayment

### Description
Initiates an authorized payment.

### Arguments
- **input** (UserInitiatePaymentInput!) - Required - The input object for initiating the payment.

### Type
- **UserInitiatePaymentPayload** (object) - The response object containing details of the initiated payment.
```

--------------------------------

### clientPaymentInitiationRequestCreate

Source: https://docs.stitch.money/api/mutations/client-payment-initiation-request-create

Creates a new payment initiation request using the provided input.

```APIDOC
## GraphQL Mutation: clientPaymentInitiationRequestCreate

### Description
Creates a new payment initiation request. This operation requires the `client_paymentrequest` scope.

### Signature
`clientPaymentInitiationRequestCreate(input: ClientPaymentInitiationRequestCreateInput!): ClientPaymentInitiationRequestCreatePayload`

### Arguments
- **input** (ClientPaymentInitiationRequestCreateInput!) - Required - The input object containing the details for the payment initiation request.

### Response
- **ClientPaymentInitiationRequestCreatePayload** (object) - A newly created payment initiation request.
```

--------------------------------

### TenantClientCreateInput

Source: https://docs.stitch.money/api/types/inputs/tenant-client-create-input

The TenantClientCreateInput object defines the structure required to create a new client for a tenant.

```APIDOC
## TenantClientCreateInput

### Description
Input object used to provide the necessary details when creating a client belonging to a tenant.

### Fields
- **name** (String!) - Required - The name of the client.
- **redirectUrls** ([LenientURL!]!) - Required - A list of valid redirect URLs for the client.
- **environment** (Environment!) - Required - The environment associated with the client.
- **url** (LenientURL!) - Required - The base URL for the client.
- **allowedScopes** ([Scope!]!) - Required - A list of scopes allowed for the client.
- **countryCodes** ([CountryCode!]!) - Required - A list of country codes associated with the client.
```

--------------------------------

### TenantClientCreateInput GraphQL Schema

Source: https://docs.stitch.money/api/inputs/tenant-client-create-input

Defines the structure of the input object required for client creation.

```graphql
input TenantClientCreateInput {  
  name: String!  
  redirectUrls: [LenientURL!]!  
  environment: Environment!  
  url: LenientURL!  
  allowedScopes: [Scope!]!  
  countryCodes: [CountryCode!]!  
}  
```

--------------------------------

### clientPaymentInitiationRequestCreate

Source: https://docs.stitch.money/api/operations/mutations/client-payment-initiation-request-create

Initiates a new payment request using the provided input.

```APIDOC
## GraphQL Mutation: clientPaymentInitiationRequestCreate

### Description
Creates a new payment initiation request. This operation requires the `client_paymentrequest` scope.

### Signature
`clientPaymentInitiationRequestCreate(input: ClientPaymentInitiationRequestCreateInput!): ClientPaymentInitiationRequestCreatePayload`

### Arguments
- **input** (ClientPaymentInitiationRequestCreateInput!) - Required - The input object containing payment initiation details.

### Return Type
- **ClientPaymentInitiationRequestCreatePayload** (object) - The result object containing the newly created payment initiation request.
```

--------------------------------

### initiateTransaction

Source: https://docs.stitch.money/api/mutations/initiate-transaction

The initiateTransaction mutation allows users to initiate a new payment transaction by providing the required input parameters.

```APIDOC
## mutation initiateTransaction

### Description
Initiates a new payment transaction.

### Signature
`initiateTransaction(input: TransactionInitiateInput!): PaymentTransaction!`

### Arguments
- **input** (TransactionInitiateInput!) - Required - The input object containing transaction details.

### Returns
- **PaymentTransaction** (interface) - The resulting payment transaction object.
```

--------------------------------

### testClientPaymentInitiationRequestSimulateComplete

Source: https://docs.stitch.money/api/operations/mutations/test-client-payment-initiation-request-simulate-complete

A GraphQL mutation to simulate the completion of a payment initiation request.

```APIDOC
## mutation testClientPaymentInitiationRequestSimulateComplete

### Description
Simulates the completion of a payment initiation request for testing purposes.

### Arguments
- **input** (TestClientPaymentInitiationRequestSimulateCompleteInput!) - Required - The input object for the simulation.

### Return Type
- **TestClientPaymentInitiationRequestSimulateCompletePayload** - The payload containing the payment request id of the completed payment request.
```

--------------------------------

### clientDisbursementCreate

Source: https://docs.stitch.money/api/operations/mutations/client-disbursement-create

Mutation to create a client disbursement.

```APIDOC
## clientDisbursementCreate

### Description
Initiates a client disbursement. This mutation requires the `[client_disbursement]` scope.

### Signature
`clientDisbursementCreate(input: ClientDisbursementCreateInput!): ClientDisbursementCreatePayload!`

### Arguments
- **input** (ClientDisbursementCreateInput!) - Required - The input object for creating a client disbursement.

### Type
- **ClientDisbursementCreatePayload** (object) - The payload returned upon successful execution.
```

--------------------------------

### ClientPaymentAuthorizationRequestCreateInitialPaymentInput

Source: https://docs.stitch.money/api/inputs/client-payment-authorization-request-create-initial-payment-input

The input object used to specify the amount and an optional external reference for an initial payment.

```APIDOC
## ClientPaymentAuthorizationRequestCreateInitialPaymentInput

### Description
Details required to make an initial payment during the authorization process.

### Fields
- **amount** (MoneyInput!) - Required - The amount for the initial payment.
- **externalReference** (String) - Optional - An optional reference field that will be present with the redirect query parameters when the payment is completed.
```

--------------------------------

### PaymentInitiationRequestEvent Interface Definition

Source: https://docs.stitch.money/api/interfaces/payment-initiation-request-event

Defines the schema for payment initiation request events in the InstantPay system.

```graphql
interface PaymentInitiationRequestEvent {  
  occurred: Date!  
  description: String!  
  paymentMethod: String  
}  
```

--------------------------------

### client

Source: https://docs.stitch.money/api/operations/subscriptions/client

Adds a client subscription using the provided webhook input.

```APIDOC
## mutation client

### Description
Adds a client subscription to the system.

### Arguments
- **webhook** (SubscriptionWebhookInput!) - Required - The webhook configuration for the subscription.

### Return Type
- **ClientSubscription** (object)
```

--------------------------------

### PaymentInitiationEftManualPayerFilterInput

Source: https://docs.stitch.money/api/inputs/payment-initiation-eft-manual-payer-filter-input

The PaymentInitiationEftManualPayerFilterInput object allows filtering payment initiation records by amount and date.

```APIDOC
## PaymentInitiationEftManualPayerFilterInput

### Description
Input object used to filter EFT manual payer payment initiation records.

### Fields
- **amountReceived** (MoneyFilterInput) - Optional - Filter by the amount received.
- **date** (DateFilterInput) - Optional - Filter by the date of the transaction.
```

--------------------------------

### clientRefundInitiate

Source: https://docs.stitch.money/api/mutations/client-refund-initiate

Initiates a client refund process. Requires the client_refund scope.

```APIDOC
## mutation clientRefundInitiate

### Description
Initiates a client refund. This mutation requires the `client_refund` scope.

### Signature
`clientRefundInitiate(input: ClientRefundInitiateInput!): RefundInitiatePayload!`

### Arguments
#### input (ClientRefundInitiateInput!) - Required
The input object required to initiate the refund.

### Response
#### RefundInitiatePayload (object)
The result of the refund initiation process.
```

--------------------------------

### clientRefundInitiate

Source: https://docs.stitch.money/api/operations/mutations/client-refund-initiate

Initiates a client refund process. Requires the client_refund scope.

```APIDOC
## GraphQL Mutation: clientRefundInitiate

### Description
Initiates a client refund. This operation requires the `client_refund` scope.

### Signature
`clientRefundInitiate(input: ClientRefundInitiateInput!): RefundInitiatePayload!`

### Arguments
- **input** (ClientRefundInitiateInput!) - Required - The input object containing refund details.

### Type
- **RefundInitiatePayload** (object) - The result of the refund initiation.
```

--------------------------------

### initiateTransaction

Source: https://docs.stitch.money/api/operations/mutations/initiate-transaction

The initiateTransaction mutation initiates a new payment transaction.

```APIDOC
## mutation initiateTransaction

### Description
Initiates a new payment transaction.

### Arguments
- **input** (TransactionInitiateInput!) - Required - The input object containing transaction details.

### Return Type
- **PaymentTransaction** (interface) - The resulting payment transaction object.
```

--------------------------------

### clientDisbursementCreate

Source: https://docs.stitch.money/api/mutations/client-disbursement-create

Creates a new client disbursement. Requires the [client_disbursement] scope.

```APIDOC
## mutation clientDisbursementCreate

### Description
Creates a new client disbursement. This mutation requires the `[client_disbursement]` scope.

### Signature
`clientDisbursementCreate(input: ClientDisbursementCreateInput!): ClientDisbursementCreatePayload!`

### Arguments
- **input** (ClientDisbursementCreateInput!) - Required - The input object for creating a client disbursement.

### Returns
- **ClientDisbursementCreatePayload** (object) - The result of the disbursement creation.
```

--------------------------------

### ProductInput

Source: https://docs.stitch.money/api/types/inputs/product-input

GraphQL input object definition for product items.

```APIDOC
## ProductInput

### Description
Product item information supplied by the client.

### Definition
```graphql
input ProductInput {  
  sku: String!  
  name: String!  
  description: String!  
  imageUrl: String!  
  productUrl: String  
} 
```

### Fields
- **sku** (String!) - Required - Product SKU code
- **name** (String!) - Required - Product display name
- **description** (String!) - Required - Product description
- **imageUrl** (String!) - Required - Product image URL
- **productUrl** (String) - Optional - Product URL
```

--------------------------------

### cardTransactionInitiate

Source: https://docs.stitch.money/api/mutations/card-transaction-initiate

Initiates a card transaction using the provided input.

```APIDOC
## mutation cardTransactionInitiate

### Description
Initiates a card transaction.

### Arguments
- **input** (CardTransactionInitiateInput!) - Required - The input object for the transaction.

### Return Type
- **CardTransactionResponse** (union) - The response object containing the result of the transaction.
```

--------------------------------

### addCard(input: AddCardInput!): Card!

Source: https://docs.stitch.money/api/mutations/add-card

Adds a new card to the system.

```APIDOC
## addCard

### Description
Adds a new card to the system.

### Arguments
- **input** (AddCardInput!) - Required - The input object containing card details.

### Return Type
- **Card** (object) - The created card object.
```

--------------------------------

### client(webhook: SubscriptionWebhookInput!): ClientSubscription

Source: https://docs.stitch.money/api/subscriptions/client

Adds a client subscription using the provided webhook input.

```APIDOC
## client(webhook: SubscriptionWebhookInput!): ClientSubscription

### Description
Adds a client subscription to the system.

### Arguments
- **webhook** (SubscriptionWebhookInput!) - Required - The webhook configuration for the subscription.

### Returns
- **ClientSubscription** (object) - The created client subscription object.
```

--------------------------------

### ClientPaymentInitiationRequestCreateInput Schema

Source: https://docs.stitch.money/api/inputs/client-payment-initiation-request-create-input

The GraphQL input schema defining the structure for payment initiation requests.

```graphql
input ClientPaymentInitiationRequestCreateInput {  
  amount: MoneyInput!  
  merchantId: String  
  beneficiary: BeneficiaryInput  
  payerReference: String!  
  payerInformation: PayerInformationInput  
  beneficiaryReference: String!  
  externalReference: String  
  expireAt: Date  
  merchant: String  
  iframeAllowlist: [String]  
  restrictPayerBank: PayerBankId  
  merchantDetails: MerchantDetailsInput  
  paymentMethods: PaymentMethodsInput  
}  
```

--------------------------------

### ClientPaymentAuthorizationRequestCreateInitialPaymentInput Schema

Source: https://docs.stitch.money/api/inputs/client-payment-authorization-request-create-initial-payment-input

Defines the structure for the initial payment input object.

```graphql
input ClientPaymentAuthorizationRequestCreateInitialPaymentInput {  
  amount: MoneyInput!  
  externalReference: String  
}  

```

--------------------------------

### TipOptionsInput GraphQL Definition

Source: https://docs.stitch.money/api/types/inputs/tip-options-input

Defines the input structure for tip options, requiring a non-null MoneyInput object.

```graphql
input TipOptionsInput {  
  amount: MoneyInput!  
}  
```

--------------------------------

### PaymentInitiationCryptoPayerFilterInput

Source: https://docs.stitch.money/api/inputs/payment-initiation-crypto-payer-filter-input

The PaymentInitiationCryptoPayerFilterInput object allows filtering of payment initiation records based on cryptocurrency, amount, and date criteria.

```APIDOC
## PaymentInitiationCryptoPayerFilterInput

### Description
An input object used to filter cryptocurrency payment initiation data.

### Fields
- **cryptocurrency** (StringFilterInput) - Optional - Filter by cryptocurrency type.
- **cryptocurrencyAmountReceived** (DecimalFilterInput) - Optional - Filter by the amount of cryptocurrency received.
- **date** (DateFilterInput) - Optional - Filter by the date of the transaction.
```

--------------------------------

### clientWebhookAdd

Source: https://docs.stitch.money/api/mutations/client-webhook-add

Registers a new webhook to listen to events. This is a GraphQL mutation.

```APIDOC
## mutation clientWebhookAdd

### Description
Adds a webhook to listen to an event.

### Signature
clientWebhookAdd(input: ClientAddWebhookInput!): AddWebhookPayload

### Arguments
- **input** (ClientAddWebhookInput!) - Required - The input object containing webhook configuration details.

### Return Type
- **AddWebhookPayload** (object) - The result of the webhook creation operation.
```

--------------------------------

### TestClientPaymentInitiationRequestSimulateCompleteInput

Source: https://docs.stitch.money/api/inputs/test-client-payment-initiation-request-simulate-complete-input

The input object used to simulate the completion of a payment initiation request.

```APIDOC
## TestClientPaymentInitiationRequestSimulateCompleteInput

### Description
This input object is used to mark a payment request as completed. It requires a payment request ID and a simulated payment method.

### Fields
- **paymentRequestId** (ID!) - Required - The unique identifier of the payment request.
- **paymentMethod** (SimulatedCompletedPaymentMethod!) - Required - The simulated payment method used for completion.
- **eft** (EftCompleteInput) - Optional - Additional EFT completion details.
```

--------------------------------

### PaymentInitiationCompletedFilterInput

Source: https://docs.stitch.money/api/inputs/payment-initiation-completed-filter-input

The PaymentInitiationCompletedFilterInput object allows filtering of payment initiation completion data.

```APIDOC
## PaymentInitiationCompletedFilterInput

### Description
Input object used for filtering payment initiation completion records.

### Fields
- **id** (IDFilterInput) - Filter by ID.
- **date** (DateFilterInput) - Filter by date.
- **payer** (PaymentInitiationPayerFilterInput) - Filter by payer information.
```

--------------------------------

### PaymentInitiationRequestManuallyCompletedFilterInput

Source: https://docs.stitch.money/api/inputs/payment-initiation-request-manually-completed-filter-input

The PaymentInitiationRequestManuallyCompletedFilterInput input object allows filtering payment initiation requests based on a date range.

```APIDOC
## PaymentInitiationRequestManuallyCompletedFilterInput

### Description
Input object used to filter payment initiation requests by date.

### Fields
- **date** (DateFilterInput) - Optional - Filter by date range.
```

--------------------------------

### OrderInput GraphQL Definition

Source: https://docs.stitch.money/api/types/inputs/order-input

Defines the required fields for an order, including the URL and product list.

```graphql
input OrderInput {  
  url: String!  
  products: [ProductInput!]!  
}  
```

--------------------------------

### SimulatePaymentMethodInput

Source: https://docs.stitch.money/api/inputs/simulate-payment-method-input

The SimulatePaymentMethodInput input object definition.

```APIDOC
## SimulatePaymentMethodInput

### Description
Input object used to simulate a payment method.

### Fields
- **completed** (SimulatedCompletedPaymentMethod!) - Required - The status of the simulated payment method.
```

--------------------------------

### ProductInput GraphQL Schema Definition

Source: https://docs.stitch.money/api/types/inputs/product-input

Defines the input object type for product data submission.

```graphql
input ProductInput {  
  sku: String!  
  name: String!  
  description: String!  
  imageUrl: String!  
  productUrl: String  
}  
```

--------------------------------

### clientPayoutBatchCreate

Source: https://docs.stitch.money/api/mutations/client-payout-batch-create

Creates a new payout batch using the provided input.

```APIDOC
## GraphQL Mutation: clientPayoutBatchCreate

### Description
Creates a new payout batch. This mutation requires the `client_disbursement` scope.

### Signature
`clientPayoutBatchCreate(input: PayoutBatchCreateInput!): PayoutBatchCreatePayload!`

### Arguments
- **input** (PayoutBatchCreateInput!) - Required - The input object containing the details for the payout batch creation.

### Response
- **Returns** (PayoutBatchCreatePayload!) - The result of the payout batch creation operation.
```

--------------------------------

### Define the include directive

Source: https://docs.stitch.money/api/directives/include

Schema definition for the include directive, specifying its arguments and valid locations.

```graphql
directive @include(  
  if: Boolean!  
) on   
  | FIELD  
  | FRAGMENT_SPREAD  
  | INLINE_FRAGMENT  
```

--------------------------------

### userDisbursementCreate

Source: https://docs.stitch.money/api/operations/mutations/user-disbursement-create

The userDisbursementCreate mutation is used to initiate a disbursement process.

```APIDOC
## mutation userDisbursementCreate

### Description
Creates a new user disbursement.

### Arguments
- **input** (UserDisbursementCreateInput!) - Required - The input object containing disbursement details.

### Return Type
- **UserDisbursementCreatePayload** (object) - The result of the disbursement creation operation.
```

--------------------------------

### clientSubscriptionMigrate

Source: https://docs.stitch.money/api/mutations/client-subscription-migrate

A GraphQL mutation to migrate a subscription to SVIX webhooks.

```APIDOC
## mutation clientSubscriptionMigrate

### Description
Migrates a specified subscription to the SVIX webhook system.

### Arguments
- **subscriptionId** (ID!) - Required - The unique identifier of the subscription to migrate.

### Return Type
- **AddWebhookPayload** (object) - The result of the migration operation.
```

--------------------------------

### SimulatePaymentMethodInput GraphQL Definition

Source: https://docs.stitch.money/api/inputs/simulate-payment-method-input

Defines the input object type for simulating payment methods.

```graphql
input SimulatePaymentMethodInput {  
  completed: SimulatedCompletedPaymentMethod!  
}  
```

--------------------------------

### refundTransactionInitiate

Source: https://docs.stitch.money/api/operations/mutations/refund-transaction-initiate

Initiates a refund for a specific transaction. This mutation requires the [client_refund] scope and returns a PaymentTransaction interface.

```APIDOC
## GraphQL Mutation: refundTransactionInitiate

### Description
Initiates a refund for a transaction. This operation requires the `[client_refund]` scope.

### Signature
`refundTransactionInitiate(input: RefundTransactionInitiateInput!): PaymentTransaction!`

### Arguments
- **input** (RefundTransactionInitiateInput!) - Required - The input object containing details for the refund initiation.

### Return Type
- **PaymentTransaction** (interface) - The resulting transaction object after the refund initiation.
```

--------------------------------

### UserDisbursementCreateInput

Source: https://docs.stitch.money/api/types/inputs/user-disbursement-create-input

The UserDisbursementCreateInput object defines the parameters required to initiate a disbursement.

```APIDOC
## UserDisbursementCreateInput

### Description
Input object used for creating a user disbursement.

### Fields
- **amount** (MoneyInput!) - Required - The currency and quantity to be disbursed
- **nonce** (String!) - Required - Randomly generated unique string to ensure idempotency
- **beneficiaryReference** (String!) - Required - The reference that will be displayed on the users statement
- **externalReference** (String) - Optional - An optional field that allows attaching an external reference identifier to the disbursement for tracking or reconciliation purposes
- **disbursementType** (DisbursementType) - Optional - Affects how soon the disbursement will be paid out
- **recipientAccountHolder** (DisbursementCreateRecipientAccountHolderDetailsInput) - Optional - Details which identify the recipient of the disbursement.
```

--------------------------------

### userDisbursementCreate

Source: https://docs.stitch.money/api/mutations/user-disbursement-create

The userDisbursementCreate mutation is used to initiate a disbursement request.

```APIDOC
## userDisbursementCreate

### Description
Creates a new user disbursement.

### Arguments
- **input** (UserDisbursementCreateInput!) - Required - The input object containing disbursement details.

### Return Type
- **UserDisbursementCreatePayload** (object) - The result of the disbursement creation process.
```

--------------------------------

### TipOptionsInput

Source: https://docs.stitch.money/api/types/inputs/tip-options-input

Definition of the TipOptionsInput GraphQL input type and its fields.

```APIDOC
## TipOptionsInput

### Description
Input object used to specify tip details.

### Fields
- **amount** (MoneyInput!) - Required - The monetary amount for the tip.
```

--------------------------------

### PaymentInitiationWebhookSubscription GraphQL Type Definition

Source: https://docs.stitch.money/api/objects/payment-initiation-webhook-subscription

Represents the schema definition for the PaymentInitiationWebhookSubscription object, which implements the WebhookSubscription interface.

```graphql
type PaymentInitiationWebhookSubscription implements WebhookSubscription {  
  id: ID!  
  query: String  
  createdAt: Date  
  url: URL!  
  hmacSha256Key: String  
  headers: [Header!]  
}  
```

--------------------------------

### PaymentInitiationBnplPayerFilterInput

Source: https://docs.stitch.money/api/types/inputs/payment-initiation-bnpl-payer-filter-input

The PaymentInitiationBnplPayerFilterInput input object definition.

```APIDOC
## PaymentInitiationBnplPayerFilterInput

### Description
Input object used to filter payment initiation BNPL payer records.

### Fields
- **date** (DateFilterInput) - Optional - Filter by date range.
```

--------------------------------

### refundTransactionInitiate

Source: https://docs.stitch.money/api/mutations/refund-transaction-initiate

Initiates a refund for a transaction. This mutation requires the client_refund scope.

```APIDOC
## refundTransactionInitiate

### Description
Initiates a refund for a specific transaction.

### Scope
`client_refund`

### Signature
`refundTransactionInitiate(input: RefundTransactionInitiateInput!): PaymentTransaction!`

### Arguments
- **input** (RefundTransactionInitiateInput!) - Required - The input object containing refund details.

### Returns
- **PaymentTransaction** (interface) - The resulting payment transaction object.
```

--------------------------------

### AmountConfig GraphQL Input Definition

Source: https://docs.stitch.money/api/inputs/amount-config

Defines the structure of the AmountConfig input object, which accepts either a fixed or variable amount.

```graphql
input AmountConfig {  
  fixedAmount: FixedAmountInput  
  variableAmount: VariableAmountInput  
}  
```

--------------------------------

### ScreenDimensions Input Definition

Source: https://docs.stitch.money/api/inputs/screen-dimensions

Defines the required height and width fields for screen dimensions.

```graphql
input ScreenDimensions {  
  height: String!  
  width: String!  
}  
```

--------------------------------

### userPaymentInitiationRequestCreate

Source: https://docs.stitch.money/api/operations/mutations/user-payment-initiation-request-create

Creates a new payment initiation request. This operation is deprecated.

```APIDOC
## mutation userPaymentInitiationRequestCreate

### Description
Creates a new payment initiation request. This field is deprecated and will be removed in a future release; please use `userInitiatePayment` instead.

### Required Scope
`[paymentinitiationrequest]`

### Signature
`userPaymentInitiationRequestCreate(input: UserPaymentInitiationRequestCreateInput!): UserPaymentInitiationRequestCreatePayload`

### Arguments
- **input** (UserPaymentInitiationRequestCreateInput!) - Required - The input object for creating the payment initiation request.

### Return Type
- **UserPaymentInitiationRequestCreatePayload** (object) - The result containing the newly created payment initiation request.
```

--------------------------------

### UserDisbursementCreateInput GraphQL Definition

Source: https://docs.stitch.money/api/types/inputs/user-disbursement-create-input

The schema definition for the UserDisbursementCreateInput object.

```graphql
input UserDisbursementCreateInput {  
  amount: MoneyInput!  
  nonce: String!  
  beneficiaryReference: String!  
  externalReference: String  
  disbursementType: DisbursementType  
  recipientAccountHolder: DisbursementCreateRecipientAccountHolderDetailsInput  
}  
```

--------------------------------

### PaymentInitiationStatus Union Definition

Source: https://docs.stitch.money/api/types/unions/payment-initiation-status

Defines the possible states for a payment initiation process.

```graphql
union PaymentInitiationStatus = PaymentInitiationCompleted | PaymentInitiationPending | PaymentInitiationFailed | PaymentInitiationCancelled | PaymentInitiationExpired
```

--------------------------------

### AddPayoutBatchPayoutsInput GraphQL Schema

Source: https://docs.stitch.money/api/inputs/add-payout-batch-payouts-input

Defines the required fields for the AddPayoutBatchPayoutsInput input object.

```graphql
input AddPayoutBatchPayoutsInput {  
  batchId: ID!  
  disbursements: [PayoutBatchDisbursementCreateInput!]!  
}  
```

--------------------------------

### Add client subscription operation

Source: https://docs.stitch.money/api/operations/subscriptions/client

Defines the GraphQL operation to create a client subscription using a webhook input.

```graphql
client(  
  webhook: SubscriptionWebhookInput!  
): ClientSubscription  
```

--------------------------------

### UserDisbursementCreateInput GraphQL Schema

Source: https://docs.stitch.money/api/inputs/user-disbursement-create-input

Defines the required fields for initiating a disbursement request.

```graphql
input UserDisbursementCreateInput {  
  amount: MoneyInput!  
  nonce: String!  
  beneficiaryReference: String!  
  disbursementType: DisbursementType  
  recipientAccountHolder: DisbursementCreateRecipientAccountHolderDetailsInput  
}  
```

--------------------------------

### PaymentInitiationCashRetailerPayerFilterInput

Source: https://docs.stitch.money/api/inputs/payment-initiation-cash-retailer-payer-filter-input

The PaymentInitiationCashRetailerPayerFilterInput input object allows filtering by date.

```APIDOC
## PaymentInitiationCashRetailerPayerFilterInput

### Description
Input object used to filter payment initiation cash retailer payer records.

### Fields
- **date** (DateFilterInput) - Optional - Filter by date.
```

--------------------------------

### ClientDisbursementCreateInput

Source: https://docs.stitch.money/api/inputs/client-disbursement-create-input

The ClientDisbursementCreateInput object defines the structure for creating a client disbursement.

```APIDOC
## ClientDisbursementCreateInput

### Description
Input object used for creating a client disbursement.

### Fields
- **amount** (MoneyInput!) - Required - The currency and quantity to be disbursed
- **nonce** (String!) - Required - Randomly generated unique string to ensure idempotency
- **disbursementType** (DisbursementType) - Optional - Affects how soon the disbursement will be paid out
- **beneficiaryReference** (String!) - Required - The reference that will be displayed on the users statement. Any numeric and alpha-numeric values are accepted. However, beneficiaryReference length may be truncated according to the banking guidelines
- **bankBeneficiary** (ClientDisbursementCreateBeneficiaryBankAccountInput!) - Required - The bank beneficiary of the disbursement
- **recipientAccountHolder** (DisbursementCreateRecipientAccountHolderDetailsInput) - Optional - Details which identify the recipient of the disbursement.
```

--------------------------------

### EftPaymentMethodInput

Source: https://docs.stitch.money/api/inputs/eft-payment-method-input

The EftPaymentMethodInput input object allows configuration of multiple EFT-based payment methods.

```APIDOC
## EftPaymentMethodInput

### Description
Input object used to configure EFT payment methods.

### Fields
- **enabled** (Boolean) - Whether the EFT payment method is enabled.
- **capitecPay** (CapitecPayInput) - Configuration for Capitec Pay.
- **manual** (EftManualMethodInput) - Configuration for manual EFT.
- **absaEft** (AbsaEftInput) - Configuration for Absa EFT.
- **payshapRequest** (PayshapRequestInput) - Configuration for PayShap requests.
```

--------------------------------

### UserPaymentInitiationRequestCreateInput GraphQL Schema

Source: https://docs.stitch.money/api/inputs/user-payment-initiation-request-create-input

The definition of the input object used for creating payment initiation requests.

```graphql
input UserPaymentInitiationRequestCreateInput {  
  amount: MoneyInput!  
  beneficiary: BeneficiaryInput!  
  payerReference: String!  
  beneficiaryReference: String!  
  externalReference: String  
  payerConstraint: UserPaymentInitiationRequestCreatePayerConstraintInput  
  merchant: String  
  expireAt: Date  
  restrictPayerBank: PayerBankId  
}  
```

--------------------------------

### mutation userPaymentInitiationRequestCreate

Source: https://docs.stitch.money/api/mutations/user-payment-initiation-request-create

Creates a new payment initiation request. Note that this mutation is deprecated and users should migrate to userInitiatePayment.

```APIDOC
## mutation userPaymentInitiationRequestCreate

### Description
Creates a new payment initiation request. This field is deprecated and will be removed in a future release; please use `userInitiatePayment` instead.

### Required Scope
`[paymentinitiationrequest]`

### Signature
```graphql
userPaymentInitiationRequestCreate(
  input: UserPaymentInitiationRequestCreateInput!
): UserPaymentInitiationRequestCreatePayload @deprecated
```

### Arguments
#### input (UserPaymentInitiationRequestCreateInput!) - Required
- The input object required to create the payment initiation request.

### Response
#### UserPaymentInitiationRequestCreatePayload (object)
- A newly created payment initiation request.
```

--------------------------------

### addCard(input: AddCardInput!): Card!

Source: https://docs.stitch.money/api/operations/mutations/add-card

Adds a new card to the system. This mutation requires an AddCardInput object and returns a Card object.

```APIDOC
## addCard

### Description
Adds a new card to the system.

### Arguments
- **input** (AddCardInput!) - Required - The input object containing card details.

### Type
- **Card** (object) - The resulting card object.
```

--------------------------------

### TransactionInitiateInput

Source: https://docs.stitch.money/api/types/inputs/transaction-initiate-input

The TransactionInitiateInput input object used for initiating transactions.

```APIDOC
## TransactionInitiateInput

### Description
Input object used to define the parameters for initiating a transaction.

### Fields
- **paymentRequestId** (ID) - Optional - Unique identifier for the payment request.
- **amount** (MoneyInput!) - Required - The amount to be transacted.
- **nonce** (String!) - Required - A unique string used to prevent replay attacks.
- **externalReference** (String) - Optional - An external reference identifier.
- **payerInformation** (PayerInformationInput) - Optional - Details regarding the payer.
- **deviceInformation** (DeviceInformationInput) - Optional - Information about the device used for the transaction.
- **merchantId** (String) - Optional - The identifier for the merchant.
- **beneficiaryAccountId** (ID) - Optional - The identifier for the beneficiary account.
- **metadata** (Json) - Optional - Additional metadata for the transaction.
- **splitSettlements** ([SplitSettlementInput!]) - Optional - List of split settlement configurations.
- **token** (ID) - Optional - A token representing the payment method.
- **paymentMethods** (PaymentMethodsTransactionInput) - Optional - Configuration for payment methods.
```

--------------------------------

### PaymentInitiationFailedFilterInput

Source: https://docs.stitch.money/api/inputs/payment-initiation-failed-filter-input

The PaymentInitiationFailedFilterInput input object allows filtering payment initiation failures by ID, reason, or date.

```APIDOC
## PaymentInitiationFailedFilterInput

### Description
Input object used to filter payment initiation failures.

### Fields
- **id** (IDFilterInput) - Filter by ID.
- **reason** (StringFilterInput) - Filter by failure reason.
- **date** (DateFilterInput) - Filter by date.
```

--------------------------------

### clientWebhookAdd

Source: https://docs.stitch.money/api/operations/mutations/client-webhook-add

Registers a new webhook to receive event notifications.

```APIDOC
## GraphQL Mutation: clientWebhookAdd

### Description
Adds a webhook to listen to a specific event.

### Signature
clientWebhookAdd(input: ClientAddWebhookInput!): AddWebhookPayload

### Arguments
- **input** (ClientAddWebhookInput!) - Required - The input object containing webhook configuration details.

### Type
- **AddWebhookPayload** (object) - The response object returned upon successful execution.
```

--------------------------------

### DaisyClientAddWebhookInput GraphQL Definition

Source: https://docs.stitch.money/api/inputs/daisy-client-add-webhook-input

The schema definition for the DaisyClientAddWebhookInput input object.

```graphql
input DaisyClientAddWebhookInput {  
  url: URL!  
  filterTypes: [String!]!  
  secret: String  
}  
```

--------------------------------

### PaymentInitiationPendingFilterInput GraphQL Definition

Source: https://docs.stitch.money/api/inputs/payment-initiation-pending-filter-input

Defines the input fields available for filtering pending payment initiations.

```graphql
input PaymentInitiationPendingFilterInput {  
  id: IDFilterInput  
  url: URLFilterInput  
}  
```

--------------------------------

### SubscriptionWebhookInput GraphQL Definition

Source: https://docs.stitch.money/api/inputs/subscription-webhook-input

Defines the input fields required to configure a subscription webhook.

```graphql
input SubscriptionWebhookInput {  
  url: URL!  
  headers: [InputHeader!]  
  secret: SubscriptionWebhookSecret  
}  
```

--------------------------------

### mutation testClientPaymentInitiationRequestSimulateComplete

Source: https://docs.stitch.money/api/mutations/test-client-payment-initiation-request-simulate-complete

Executes the testClientPaymentInitiationRequestSimulateComplete mutation to simulate a payment completion.

```APIDOC
## mutation testClientPaymentInitiationRequestSimulateComplete

### Description
Simulates the completion of a payment initiation request for testing purposes.

### Arguments
- **input** (TestClientPaymentInitiationRequestSimulateCompleteInput!) - Required - The input object containing the necessary data to simulate the completion.

### Response
- **TestClientPaymentInitiationRequestSimulateCompletePayload** (object) - Returns the payment request id of the completed payment request.
```

--------------------------------

### TipOptionsFilterInput Schema Definition

Source: https://docs.stitch.money/api/types/inputs/tip-options-filter-input

The GraphQL input object definition for filtering tip options by amount.

```graphql
input TipOptionsFilterInput {  
  amount: MoneyFilterInput  
}  
```

--------------------------------

### PaymentInitiationRequestFilterInput Schema Definition

Source: https://docs.stitch.money/api/inputs/payment-initiation-request-filter-input

The GraphQL input object definition for filtering payment initiation requests.

```graphql
input PaymentInitiationRequestFilterInput {  
  id: IDFilterInput  
  url: URLFilterInput  
  created: DateFilterInput  
  updated: DateFilterInput  
  amount: MoneyFilterInput  
  userReference: StringFilterInput  
  payerReference: StringFilterInput  
  payerInformation: PayerInformationFilterInput  
  beneficiaryReference: StringFilterInput  
  externalReference: StringFilterInput  
  merchant: StringFilterInput  
  beneficiaries: BeneficiaryFilterListInput  
  state: PaymentInitiationRequestStateFilterInput  
  paymentConfirmation: PaymentConfirmationFilterInput  
  settlement: SettlementFilterInput  
  payerConstraints: PayerConstraintsFilterInput  
  refunds: RefundFilterListInput  
  expireAt: DateFilterInput  
  events: PaymentInitiationRequestEventFilterListInput  
  restrictPayerBank: PayerBankIdFilterInput  
  paymentMethods: PaymentMethodOptionsFilterListInput  
}  
```

--------------------------------

### TransactionInitiateInput GraphQL Schema Definition

Source: https://docs.stitch.money/api/inputs/transaction-initiate-input

Defines the input fields required to initiate a transaction. Note that either a token or paymentMethods must be provided.

```graphql
input TransactionInitiateInput {  
  paymentRequestId: ID  
  amount: MoneyInput!  
  nonce: String!  
  externalReference: String  
  payerInformation: PayerInformationInput  
  deviceInformation: DeviceInformationInput  
  merchantId: String  
  token: ID  
  paymentMethods: PaymentMethodsTransactionInput  
}  
```

--------------------------------

### ClientAddWebhookInput GraphQL Definition

Source: https://docs.stitch.money/api/inputs/client-add-webhook-input

Defines the input object for adding a webhook, including the required URL and filter types.

```graphql
input ClientAddWebhookInput {  
  url: URL!  
  filterTypes: [String!]!  
}  
```

--------------------------------

### selfserveCreatePayment

Source: https://docs.stitch.money/api/mutations/selfserve-create-payment

Initiates a payment request for a specified client.

```APIDOC
## mutation selfserveCreatePayment

### Description
Initiates a payment request for a client. This mutation requires the `tenant_paymentrequestcreate` scope.

### Arguments
- **input** (ClientPaymentInitiationRequestCreateInput!) - Required - The payment initiation request details.
- **clientId** (String!) - Required - The unique identifier for the client.

### Return Type
- **SelfServeCreatePaymentPayload** (object) - The result of the payment initiation request.
```

--------------------------------

### TestClientCreatePaymentConfirmationInput Schema Definition

Source: https://docs.stitch.money/api/inputs/test-client-create-payment-confirmation-input

Defines the structure of the input object required for creating payment confirmations.

```graphql
input TestClientCreatePaymentConfirmationInput {  
  paymentRequestId: ID!  
}  

```

--------------------------------

### clientSubscriptionMigrate

Source: https://docs.stitch.money/api/operations/mutations/client-subscription-migrate

Migrates a specified subscription to SVIX webhooks.

```APIDOC
## mutation clientSubscriptionMigrate

### Description
Migrates a subscription to SVIX webhooks.

### Arguments
- **subscriptionId** (ID!) - Required - The ID of the subscription to migrate.

### Return Type
- **AddWebhookPayload** (object)
```

--------------------------------

### PaymentInitiationRequestStateFilterInput Definition

Source: https://docs.stitch.money/api/inputs/payment-initiation-request-state-filter-input

The GraphQL input object definition for filtering payment initiation requests by state.

```graphql
input PaymentInitiationRequestStateFilterInput {  
  typename: PaymentInitiationRequestStateUnionFilterDisciminatorFilterInput  
  PaymentInitiationRequestCompleted: PaymentInitiationRequestCompletedFilterInput  
  PaymentInitiationRequestManuallyCompleted: PaymentInitiationRequestManuallyCompletedFilterInput  
  PaymentInitiationRequestCancelled: PaymentInitiationRequestCancelledFilterInput  
  PaymentInitiationRequestExpired: PaymentInitiationRequestExpiredFilterInput  
  PaymentInitiationRequestPending: PaymentInitiationRequestPendingFilterInput  
}  
```

--------------------------------

### cardCreate

Source: https://docs.stitch.money/api/mutations/card-create

Executes a card creation transaction.

```APIDOC
## cardCreate

### Description
Initiates a card transaction using the provided input.

### Arguments
- **input** (CardCreateInput!) - Required - The input object containing card creation details.

### Return Type
- **CardTransactionResponse** (union) - The result of the card transaction.
```

--------------------------------

### ClientRefundInitiateInput

Source: https://docs.stitch.money/api/inputs/client-refund-initiate-input

The ClientRefundInitiateInput object defines the required and optional fields for initiating a refund.

```APIDOC
## ClientRefundInitiateInput

### Description
Input object used to initiate a refund request.

### Fields
- **paymentRequestId** (ID!) - Required - Unique identifier for the payment request.
- **amount** (MoneyInput!) - Required - The amount to be refunded.
- **reason** (RefundReason!) - Required - The reason for the refund.
- **nonce** (String!) - Required - Randomly generated unique string to ensure idempotency.
- **beneficiaryReference** (String!) - Required - The reference displayed on the refunded user's statement (1-30 characters).
- **clearingType** (ClearingType) - Optional - Affects how soon the refund will be paid out.
```

--------------------------------

### Client.webhookEndpoints

Source: https://docs.stitch.money/api/types/objects/client

Retrieves a list of configured webhook endpoints.

```APIDOC
## Client.webhookEndpoints

### Description
Returns a list of Endpoint objects.

### Parameters
- **filter** ([String!]) - Optional - Filter criteria for endpoints
```

--------------------------------

### PaymentInitiationCancelledFilterInput

Source: https://docs.stitch.money/api/inputs/payment-initiation-cancelled-filter-input

The PaymentInitiationCancelledFilterInput object is used to filter payment initiation cancellation queries.

```APIDOC
## PaymentInitiationCancelledFilterInput

### Description
Input object used for filtering payment initiation cancellation records.

### Fields
- **id** (IDFilterInput) - Filter by cancellation ID.
- **reason** (StringFilterInput) - Filter by cancellation reason.
- **date** (DateFilterInput) - Filter by cancellation date.
```

--------------------------------

### testClientCreatePaymentConfirmation

Source: https://docs.stitch.money/api/operations/mutations/test-client-create-payment-confirmation

Executes the testClientCreatePaymentConfirmation mutation to add a payment confirmation for a specific payment request.

```APIDOC
## mutation testClientCreatePaymentConfirmation

### Description
Adds a payment confirmation for a payment request in the test client environment.

### Arguments
- **input** (TestClientCreatePaymentConfirmationInput!) - Required - The input object containing details for the payment confirmation.

### Type
- **TestClientCreatePaymentConfirmationPayload** (object) - Returns the ID of the payment request for which a paymentConfirmation was added.
```

--------------------------------

### Client.webhookLogin

Source: https://docs.stitch.money/api/types/objects/client

Performs a webhook login operation.

```APIDOC
## Client.webhookLogin

### Description
Returns a WebhookLoginResponse object.
```

--------------------------------

### clientCollectionBatchCreate

Source: https://docs.stitch.money/api/operations/mutations/client-collection-batch-create

A GraphQL mutation to perform a batch creation of collections.

```APIDOC
## mutation clientCollectionBatchCreate

### Description
Creates a batch of collections based on the provided input.

### Arguments
- **input** (CollectionBatchCreateInput!) - Required - The input object containing the data for the batch creation.

### Type
- **CollectionBatchPayload** (object) - The payload returned upon successful execution.
```

--------------------------------

### Client.directDeposits

Source: https://docs.stitch.money/api/types/objects/client

Retrieves a connection of direct deposits with support for pagination and filtering.

```APIDOC
## Client.directDeposits

### Description
Returns a DirectDepositConnection object containing direct deposits. Supports forward and backward pagination using cursors and filtering via DirectDepositFilterInput.

### Parameters
- **first** (UInt) - Optional - Specifies the maximum number of results to return
- **last** (UInt) - Optional - Specifies the maximum number of results to return for backwards pagination
- **before** (Cursor) - Optional - Takes in the paging cursor. The next page of results will start after this cursor
- **after** (Cursor) - Optional - Takes in the paging cursor. The previous page of results will start before this cursor
- **filter** (DirectDepositFilterInput) - Optional - Filter criteria for direct deposits
```

--------------------------------

### ClientRefundInitiateInput GraphQL Schema Definition

Source: https://docs.stitch.money/api/inputs/client-refund-initiate-input

Defines the input object structure for initiating a refund, including required fields for idempotency and payment details.

```graphql
input ClientRefundInitiateInput {  
  paymentRequestId: ID!  
  amount: MoneyInput!  
  reason: RefundReason!  
  nonce: String!  
  beneficiaryReference: String!  
  clearingType: ClearingType  
}  
```

--------------------------------

### AbsaEftInput

Source: https://docs.stitch.money/api/inputs/absa-eft-input

The AbsaEftInput object is used to configure Absa EFT payment inputs.

```APIDOC
## AbsaEftInput

### Description
Input object for configuring Absa EFT payment details.

### Fields
- **payerDisplayNarrative** (String) - Description of the item or service the user is paying for, displayed on the Absa app during payment approval.
- **enabled** (Boolean) - Support status for the input.
```

--------------------------------

### TenantClient GraphQL Type Definition

Source: https://docs.stitch.money/api/objects/tenant-client

The schema definition for the TenantClient object, outlining all available fields and their types.

```graphql
type TenantClient {  
  id: ID!  
  name: String!  
  environment: Environment!  
  url: LenientURL!  
  redirectUrls: [LenientURL!]!  
  allowedGrantTypes: [String!]!  
  allowedScopes: [Scope!]!  
  identityTokenLifetime: Int!  
  accessTokenLifetime: Int!  
  authorizationCodeLifetime: Int!  
  absoluteRefreshTokenLifetime: Int!  
  slidingRefreshTokenLifetime: Int!  
  refreshTokenUsage: Int!  
  countryCodes: [CountryCode!]!  
}  
```

--------------------------------

### PreAuthorizationInput GraphQL Schema

Source: https://docs.stitch.money/api/inputs/pre-authorization-input

Defines the input object structure for pre-authorization operations.

```graphql
input PreAuthorizationInput {  
  enabled: Boolean!  
  voidAt: Date  
}  
```

--------------------------------

### userDisbursementCreate Mutation Definition

Source: https://docs.stitch.money/api/mutations/user-disbursement-create

The signature for the userDisbursementCreate mutation.

```graphql
userDisbursementCreate(  
  input: UserDisbursementCreateInput!  
): UserDisbursementCreatePayload!  
```

--------------------------------

### PayoutBatchCreateInput GraphQL Schema

Source: https://docs.stitch.money/api/inputs/payout-batch-create-input

Defines the input object structure for creating a payout batch.

```graphql
input PayoutBatchCreateInput {  
  nonce: String!  
  disbursements: [PayoutBatchDisbursementCreateInput!]  
}  
```

--------------------------------

### tenantClientCreate Mutation Definition

Source: https://docs.stitch.money/api/mutations/tenant-client-create

The signature for the tenantClientCreate mutation, which accepts a TenantClientCreateInput object and returns a TenantClientCreatePayload.

```graphql
tenantClientCreate(  
  input: TenantClientCreateInput!  
): TenantClientCreatePayload!  
```

--------------------------------

### Client.subscriptions

Source: https://docs.stitch.money/api/types/objects/client

Retrieves client subscription details.

```APIDOC
## Client.subscriptions

### Description
Returns ClientSubscriptionDetails. Requires scope: [client_paymentrequest].
```
Tokens:
Raw