# refundTransaction

Mutation · GraphQL API

Refund a settled transaction and return a payload that includes details of the refund.

## Authentication

- SERVER

## Input

- `input` (`RefundTransactionInput!`) — required

## Returns [RefundTransactionPayload](/braintree/graphql/reference/types/refund-transaction-payload)

Top-level output field from refunding a transaction.

### Returned fields

- `clientMutationId` (`String`): An identifier used to reconcile requests and responses. 255 characters maximum.
- `refund` (`Refund`): The information about the created refund.

## Examples

### Refund transaction 3D Secure

Refund a settled transaction and return a payload that includes details of the refund.

```graphql
mutation refundTransaction3DSecure($input: RefundTransactionInput!, $authenticationInsightInput: AuthenticationInsightInput!)  {
  refundTransaction(input: $input) {
    clientMutationId
    refund {
      __typename
      id
      legacyId
      createdAt
      amount {
        value
        currencyCode
      }
      orderId
      status
      processorAuthorizationResponse {
        legacyCode
        message
        cvvResponse
        avsPostalCodeResponse
        avsStreetAddressResponse
        authorizationId
        additionalInformation
        retrievalReferenceNumber
        emvData
        mastercardTransactionLinkId
      }
      statusHistory {
        __typename
        ... on AuthorizationExpiredEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
        }
        ... on AuthorizedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          riskDecision
          terminal
          authorizationExpiresAt
          userName
        }
        ... on FailedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          merchantAdviceCodeResponse {
            code
            message
          }
          riskDecision
          terminal
          userName
        }
        ... on GatewayRejectedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          gatewayRejectionReason
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          merchantAdviceCodeResponse {
            code
            message
          }
          riskDecision
          terminal
          duplicateOf {
            __typename
            id
            legacyId
          }
          userName
        }
        ... on ProcessorDeclinedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          declineType
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          merchantAdviceCodeResponse {
            code
            message
          }
          riskDecision
          terminal
          userName
        }
        ... on SettledEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
          settlementBatchId
        }
        ... on SettlementDeclinedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
        }
        ... on SettlementPendingEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
          userName
        }
        ... on SettlingEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
        }
        ... on SubmittedForSettlementEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
          userName
        }
        ... on VoidedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
          userName
        }
        ... on SettlementConfirmedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
        }
      }
      details {
        __typename
        ... on PayPalRefundDetails {
          __typename
          payPalRefundId: refundId
          refundedFee {
            value
            currencyCode
          }
          description
          reason
        }
        ... on PayPalLocalPaymentRefundDetails {
          __typename
          payPalLocalPaymentRefundId: refundId
          refundedFee {
            value
            currencyCode
          }
        }
        ... on SEPADirectDebitRefundDetails {
          __typename
          sEPADirectDebitRefundId: refundId
          refundedFee {
            value
            currencyCode
          }
          paymentId
        }
      }
      merchantAccountId
      source
      refundedTransaction {
        __typename
        id
        legacyId
      }
      paymentMethodSnapshot {
        __typename
        ... on CustomActionsPaymentMethodDetails {
          __typename
          actionName
          fields {
            name
            displayValue
          }
        }
        ... on CreditCardDetails {
          __typename
          brandCode
          last4
          bin
          binData {
            prepaid
            healthcare
            debit
            durbinRegulated
            commercial
            payroll
            issuingBank
            countryOfIssuance
            productId
            prepaidReloadable
            business
            consumer
            corporate
            purchase
          }
          expirationMonth
          expirationYear
          cardholderName
          uniqueNumberIdentifier
          origin {
            type
            details {
              __typename
              ... on ApplePayOriginDetails {
                __typename
                paymentInstrumentName
                bin
                merchantTokenIdentifier
                dpanLastTwo
                isDeviceToken
                last4
                paymentAccountReference
              }
              ... on GooglePayOriginDetails {
                __typename
                googleTransactionId
                bin
                last4
                paymentAccountReference
              }
              ... on MasterpassOriginDetails {
                __typename
                bin
              }
              ... on MetaCheckoutOriginDetails {
                __typename
                containerId
                bin
              }
              ... on NetworkTokenOriginDetails {
                __typename
                bin
              }
              ... on SamsungPayOriginDetails {
                __typename
                bin
              }
              ... on VisaCheckoutOriginDetails {
                __typename
                callId
                bin
              }
              ... on PayPalLocalPaymentOriginDetails {
                __typename
                captureId
                customField
                paymentId
                transactionFee {
                  value
                  currencyCode
                }
                blikAliases {
                  key
                  label
                }
              }
              ... on CardPresentOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                readerId
                storeId
              }
              ... on EmvCardOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                applicationPreferredName
                applicationIdentifier
                terminalVerificationResult
                cardSequenceNumber
                applicationInterchangeProfile
                terminalTransactionDate
                terminalTransactionType
                cashbackAmount
                applicationUsageControl
                terminalCountryCode
                applicationCryptogram
                cryptogramInformationData
                cardholderVerificationMethodResults
                applicationTransactionCounter
                unpredictableNumber
                issuerActionCodeDefault
                issuerActionCodeDenial
                issuerActionCodeOnline
                readerId
                storeId
              }
            }
          }
          billingAddress {
            company
            addressLine1
            addressLine2
            fullName
            adminArea2
            adminArea1
            postalCode
            countryCode
            phone {
              countryPhoneCode
              phoneNumber
              extensionNumber
            }
          }
          threeDSecure {
            authentication {
              cavv
              directoryServerTransactionId
              eciFlag
              liabilityShifted
              liabilityShiftPossible
              cardEnrolled
              authenticationStatus
              version
              xId
              threeDSecureServerTransactionId
              acsTransactionId
              paresStatus
              transactionStatus
              transactionStatusReason
            }
            authenticationInsight(input: $authenticationInsightInput) {
              merchantAccountId
              customerAuthenticationRegulationEnvironment
              customerAuthenticationIndicator
            }
          }
          cardOnFileNetworkTokenized
          paymentAccountReference
        }
        ... on PayPalTransactionDetails {
          __typename
          authorizationId
          captureId
          customField
          payer {
            __typename
            billingAgreementId
            billingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            shippingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            email
            phone
            payerId
            firstName
            lastName
            cobrandedCardLabel
            origin {
              type
              details {
                __typename
                ... on ApplePayOriginDetails {
                  __typename
                  paymentInstrumentName
                  bin
                  merchantTokenIdentifier
                  dpanLastTwo
                  isDeviceToken
                  last4
                  paymentAccountReference
                }
                ... on GooglePayOriginDetails {
                  __typename
                  googleTransactionId
                  bin
                  last4
                  paymentAccountReference
                }
                ... on MasterpassOriginDetails {
                  __typename
                  bin
                }
                ... on MetaCheckoutOriginDetails {
                  __typename
                  containerId
                  bin
                }
                ... on NetworkTokenOriginDetails {
                  __typename
                  bin
                }
                ... on SamsungPayOriginDetails {
                  __typename
                  bin
                }
                ... on VisaCheckoutOriginDetails {
                  __typename
                  callId
                  bin
                }
                ... on PayPalLocalPaymentOriginDetails {
                  __typename
                  captureId
                  customField
                  paymentId
                  transactionFee {
                    value
                    currencyCode
                  }
                  blikAliases {
                    key
                    label
                  }
                }
                ... on CardPresentOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  readerId
                  storeId
                }
                ... on EmvCardOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  applicationPreferredName
                  applicationIdentifier
                  terminalVerificationResult
                  cardSequenceNumber
                  applicationInterchangeProfile
                  terminalTransactionDate
                  terminalTransactionType
                  cashbackAmount
                  applicationUsageControl
                  terminalCountryCode
                  applicationCryptogram
                  cryptogramInformationData
                  cardholderVerificationMethodResults
                  applicationTransactionCounter
                  unpredictableNumber
                  issuerActionCodeDefault
                  issuerActionCodeDenial
                  issuerActionCodeOnline
                  readerId
                  storeId
                }
              }
            }
            limitedUseOrderId
            selectedFinancingOption {
              term
              monthlyPayment {
                value
                currencyCode
              }
              discountPercentage
              discountAmount {
                value
                currencyCode
              }
            }
            fundingSourceDescription
            vaultedBillingAgreementId
          }
          payee {
            __typename
            billingAgreementId
            billingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            shippingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            email
            phone
            payerId
            firstName
            lastName
            cobrandedCardLabel
            origin {
              type
              details {
                __typename
                ... on ApplePayOriginDetails {
                  __typename
                  paymentInstrumentName
                  bin
                  merchantTokenIdentifier
                  dpanLastTwo
                  isDeviceToken
                  last4
                  paymentAccountReference
                }
                ... on GooglePayOriginDetails {
                  __typename
                  googleTransactionId
                  bin
                  last4
                  paymentAccountReference
                }
                ... on MasterpassOriginDetails {
                  __typename
                  bin
                }
                ... on MetaCheckoutOriginDetails {
                  __typename
                  containerId
                  bin
                }
                ... on NetworkTokenOriginDetails {
                  __typename
                  bin
                }
                ... on SamsungPayOriginDetails {
                  __typename
                  bin
                }
                ... on VisaCheckoutOriginDetails {
                  __typename
                  callId
                  bin
                }
                ... on PayPalLocalPaymentOriginDetails {
                  __typename
                  captureId
                  customField
                  paymentId
                  transactionFee {
                    value
                    currencyCode
                  }
                  blikAliases {
                    key
                    label
                  }
                }
                ... on CardPresentOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  readerId
                  storeId
                }
                ... on EmvCardOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  applicationPreferredName
                  applicationIdentifier
                  terminalVerificationResult
                  cardSequenceNumber
                  applicationInterchangeProfile
                  terminalTransactionDate
                  terminalTransactionType
                  cashbackAmount
                  applicationUsageControl
                  terminalCountryCode
                  applicationCryptogram
                  cryptogramInformationData
                  cardholderVerificationMethodResults
                  applicationTransactionCounter
                  unpredictableNumber
                  issuerActionCodeDefault
                  issuerActionCodeDenial
                  issuerActionCodeOnline
                  readerId
                  storeId
                }
              }
            }
            limitedUseOrderId
            selectedFinancingOption {
              term
              monthlyPayment {
                value
                currencyCode
              }
              discountPercentage
              discountAmount {
                value
                currencyCode
              }
            }
            fundingSourceDescription
            vaultedBillingAgreementId
          }
          payerStatus
          paymentId
          sellerProtectionStatus
          taxId
          taxIdType
          transactionFee {
            value
            currencyCode
          }
          description
          origin {
            type
            details {
              __typename
              ... on ApplePayOriginDetails {
                __typename
                paymentInstrumentName
                bin
                merchantTokenIdentifier
                dpanLastTwo
                isDeviceToken
                last4
                paymentAccountReference
              }
              ... on GooglePayOriginDetails {
                __typename
                googleTransactionId
                bin
                last4
                paymentAccountReference
              }
              ... on MasterpassOriginDetails {
                __typename
                bin
              }
              ... on MetaCheckoutOriginDetails {
                __typename
                containerId
                bin
              }
              ... on NetworkTokenOriginDetails {
                __typename
                bin
              }
              ... on SamsungPayOriginDetails {
                __typename
                bin
              }
              ... on VisaCheckoutOriginDetails {
                __typename
                callId
                bin
              }
              ... on PayPalLocalPaymentOriginDetails {
                __typename
                captureId
                customField
                paymentId
                transactionFee {
                  value
                  currencyCode
                }
                blikAliases {
                  key
                  label
                }
              }
              ... on CardPresentOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                readerId
                storeId
              }
              ... on EmvCardOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                applicationPreferredName
                applicationIdentifier
                terminalVerificationResult
                cardSequenceNumber
                applicationInterchangeProfile
                terminalTransactionDate
                terminalTransactionType
                cashbackAmount
                applicationUsageControl
                terminalCountryCode
                applicationCryptogram
                cryptogramInformationData
                cardholderVerificationMethodResults
                applicationTransactionCounter
                unpredictableNumber
                issuerActionCodeDefault
                issuerActionCodeDenial
                issuerActionCodeOnline
                readerId
                storeId
              }
            }
          }
          appUsedForScanning
          recipientEmail
          recipientPhone {
            countryPhoneCode
            phoneNumber
            extensionNumber
          }
        }
        ... on VenmoAccountDetails {
          __typename
          username
          venmoUserId
        }
        ... on UsBankAccountDetails {
          __typename
          accountholderName
          usBankAccountType: accountType
          ownershipType
          bankName
          last4
          routingNumber
          verified
          achMandate {
            acceptedAt
          }
        }
        ... on LocalPaymentDetails {
          __typename
          origin {
            type
            details {
              __typename
              ... on ApplePayOriginDetails {
                __typename
                paymentInstrumentName
                bin
                merchantTokenIdentifier
                dpanLastTwo
                isDeviceToken
                last4
                paymentAccountReference
              }
              ... on GooglePayOriginDetails {
                __typename
                googleTransactionId
                bin
                last4
                paymentAccountReference
              }
              ... on MasterpassOriginDetails {
                __typename
                bin
              }
              ... on MetaCheckoutOriginDetails {
                __typename
                containerId
                bin
              }
              ... on NetworkTokenOriginDetails {
                __typename
                bin
              }
              ... on SamsungPayOriginDetails {
                __typename
                bin
              }
              ... on VisaCheckoutOriginDetails {
                __typename
                callId
                bin
              }
              ... on PayPalLocalPaymentOriginDetails {
                __typename
                captureId
                customField
                paymentId
                transactionFee {
                  value
                  currencyCode
                }
                blikAliases {
                  key
                  label
                }
              }
              ... on CardPresentOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                readerId
                storeId
              }
              ... on EmvCardOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                applicationPreferredName
                applicationIdentifier
                terminalVerificationResult
                cardSequenceNumber
                applicationInterchangeProfile
                terminalTransactionDate
                terminalTransactionType
                cashbackAmount
                applicationUsageControl
                terminalCountryCode
                applicationCryptogram
                cryptogramInformationData
                cardholderVerificationMethodResults
                applicationTransactionCounter
                unpredictableNumber
                issuerActionCodeDefault
                issuerActionCodeDenial
                issuerActionCodeOnline
                readerId
                storeId
              }
            }
          }
          type
          displayName
          implicitlyVaultedPaymentMethodId
        }
        ... on CreditCardTransactionDetails {
          __typename
          creditCard {
            __typename
            brandCode
            last4
            bin
            binData {
              prepaid
              healthcare
              debit
              durbinRegulated
              commercial
              payroll
              issuingBank
              countryOfIssuance
              productId
              prepaidReloadable
              business
              consumer
              corporate
              purchase
            }
            expirationMonth
            expirationYear
            cardholderName
            uniqueNumberIdentifier
            origin {
              type
              details {
                __typename
                ... on ApplePayOriginDetails {
                  __typename
                  paymentInstrumentName
                  bin
                  merchantTokenIdentifier
                  dpanLastTwo
                  isDeviceToken
                  last4
                  paymentAccountReference
                }
                ... on GooglePayOriginDetails {
                  __typename
                  googleTransactionId
                  bin
                  last4
                  paymentAccountReference
                }
                ... on MasterpassOriginDetails {
                  __typename
                  bin
                }
                ... on MetaCheckoutOriginDetails {
                  __typename
                  containerId
                  bin
                }
                ... on NetworkTokenOriginDetails {
                  __typename
                  bin
                }
                ... on SamsungPayOriginDetails {
                  __typename
                  bin
                }
                ... on VisaCheckoutOriginDetails {
                  __typename
                  callId
                  bin
                }
                ... on PayPalLocalPaymentOriginDetails {
                  __typename
                  captureId
                  customField
                  paymentId
                  transactionFee {
                    value
                    currencyCode
                  }
                  blikAliases {
                    key
                    label
                  }
                }
                ... on CardPresentOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  readerId
                  storeId
                }
                ... on EmvCardOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  applicationPreferredName
                  applicationIdentifier
                  terminalVerificationResult
                  cardSequenceNumber
                  applicationInterchangeProfile
                  terminalTransactionDate
                  terminalTransactionType
                  cashbackAmount
                  applicationUsageControl
                  terminalCountryCode
                  applicationCryptogram
                  cryptogramInformationData
                  cardholderVerificationMethodResults
                  applicationTransactionCounter
                  unpredictableNumber
                  issuerActionCodeDefault
                  issuerActionCodeDenial
                  issuerActionCodeOnline
                  readerId
                  storeId
                }
              }
            }
            billingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            threeDSecure {
              authentication {
                cavv
                directoryServerTransactionId
                eciFlag
                liabilityShifted
                liabilityShiftPossible
                cardEnrolled
                authenticationStatus
                version
                xId
                threeDSecureServerTransactionId
                acsTransactionId
                paresStatus
                transactionStatus
                transactionStatusReason
              }
              authenticationInsight(input: $authenticationInsightInput) {
                merchantAccountId
                customerAuthenticationRegulationEnvironment
                customerAuthenticationIndicator
              }
            }
            cardOnFileNetworkTokenized
            paymentAccountReference
          }
          networkTransactionId
          creditCardTransactionAccountType: accountType
          acquirerReferenceNumber
          processedWithCardOnFileNetworkToken
          accountBalance {
            value
            currencyCode
          }
        }
        ... on SEPADirectDebitTransactionDetails {
          __typename
          captureId
          transactionFee {
            value
            currencyCode
          }
          paymentId
        }
        ... on UsBankAccountTransactionDetails {
          __typename
          usBankAccount {
            __typename
            accountholderName
            accountType
            ownershipType
            bankName
            last4
            routingNumber
            verified
            achMandate {
              acceptedAt
            }
          }
          achType
          requestedAchType
        }
      }
      paymentMethod {
        __typename
        id
        legacyId
      }
      customer {
        __typename
        id
        legacyId
      }
      surchargeAmount
      lineItems {
        name
        kind
        quantity
        unitAmount
        totalAmount
        unitTaxAmount
        taxAmount
        discountAmount
        unitOfMeasure
        productCode
        commodityCode
        description
        url
        itemType
        imageUrl
        upc {
          upcCode
          upcType
        }
      }
      customFields {
        name
        value
      }
      descriptor {
        name
        phone
        url
      }
      disbursementDetails {
        date
        amount {
          value
          currencyCode
        }
        exchangeRate
        fundsHeld
      }
      paymentInitiatedAt
      merchantId
    }
  }
}
```

### Refund transaction

Top-level input fields for refunding a transaction.

```graphql
mutation refundTransaction($input: RefundTransactionInput!) {
  refundTransaction(input: $input) {
    clientMutationId
    refund {
      __typename
      id
      legacyId
      createdAt
      amount {
        value
        currencyCode
      }
      orderId
      status
      processorAuthorizationResponse {
        legacyCode
        message
        cvvResponse
        avsPostalCodeResponse
        avsStreetAddressResponse
        authorizationId
        additionalInformation
        retrievalReferenceNumber
        emvData
        mastercardTransactionLinkId
      }
      statusHistory {
        __typename
        ... on AuthorizationExpiredEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
        }
        ... on AuthorizedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          riskDecision
          terminal
          authorizationExpiresAt
          userName
        }
        ... on FailedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          merchantAdviceCodeResponse {
            code
            message
          }
          riskDecision
          terminal
          userName
        }
        ... on GatewayRejectedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          gatewayRejectionReason
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          merchantAdviceCodeResponse {
            code
            message
          }
          riskDecision
          terminal
          duplicateOf {
            __typename
            id
            legacyId
          }
          userName
        }
        ... on ProcessorDeclinedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          declineType
          processorResponse {
            legacyCode
            message
            cvvResponse
            avsPostalCodeResponse
            avsStreetAddressResponse
            authorizationId
            additionalInformation
            retrievalReferenceNumber
            emvData
            mastercardTransactionLinkId
          }
          networkResponse {
            code
            message
          }
          merchantAdviceCodeResponse {
            code
            message
          }
          riskDecision
          terminal
          userName
        }
        ... on SettledEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
          settlementBatchId
        }
        ... on SettlementDeclinedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
        }
        ... on SettlementPendingEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
          userName
        }
        ... on SettlingEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
        }
        ... on SubmittedForSettlementEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
          userName
        }
        ... on VoidedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          terminal
          userName
        }
        ... on SettlementConfirmedEvent {
          __typename
          status
          timestamp
          amount {
            value
            currencyCode
          }
          source
          processorResponse {
            legacyCode
            message
            achReturnCode
            achRejectReason
          }
          terminal
        }
      }
      details {
        __typename
        ... on PayPalRefundDetails {
          __typename
          payPalRefundId: refundId
          refundedFee {
            value
            currencyCode
          }
          description
          reason
        }
        ... on PayPalLocalPaymentRefundDetails {
          __typename
          payPalLocalPaymentRefundId: refundId
          refundedFee {
            value
            currencyCode
          }
        }
        ... on SEPADirectDebitRefundDetails {
          __typename
          sEPADirectDebitRefundId: refundId
          refundedFee {
            value
            currencyCode
          }
          paymentId
        }
      }
      merchantAccountId
      source
      refundedTransaction {
        __typename
        id
        legacyId
      }
      paymentMethodSnapshot {
        __typename
        ... on CustomActionsPaymentMethodDetails {
          __typename
          actionName
          fields {
            name
            displayValue
          }
        }
        ... on CreditCardDetails {
          __typename
          brandCode
          last4
          bin
          binData {
            prepaid
            healthcare
            debit
            durbinRegulated
            commercial
            payroll
            issuingBank
            countryOfIssuance
            productId
            prepaidReloadable
            business
            consumer
            corporate
            purchase
          }
          expirationMonth
          expirationYear
          cardholderName
          uniqueNumberIdentifier
          origin {
            type
            details {
              __typename
              ... on ApplePayOriginDetails {
                __typename
                paymentInstrumentName
                bin
                merchantTokenIdentifier
                dpanLastTwo
                isDeviceToken
                last4
                paymentAccountReference
              }
              ... on GooglePayOriginDetails {
                __typename
                googleTransactionId
                bin
                last4
                paymentAccountReference
              }
              ... on MasterpassOriginDetails {
                __typename
                bin
              }
              ... on MetaCheckoutOriginDetails {
                __typename
                containerId
                bin
              }
              ... on NetworkTokenOriginDetails {
                __typename
                bin
              }
              ... on SamsungPayOriginDetails {
                __typename
                bin
              }
              ... on VisaCheckoutOriginDetails {
                __typename
                callId
                bin
              }
              ... on PayPalLocalPaymentOriginDetails {
                __typename
                captureId
                customField
                paymentId
                transactionFee {
                  value
                  currencyCode
                }
                blikAliases {
                  key
                  label
                }
              }
              ... on CardPresentOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                readerId
                storeId
              }
              ... on EmvCardOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                applicationPreferredName
                applicationIdentifier
                terminalVerificationResult
                cardSequenceNumber
                applicationInterchangeProfile
                terminalTransactionDate
                terminalTransactionType
                cashbackAmount
                applicationUsageControl
                terminalCountryCode
                applicationCryptogram
                cryptogramInformationData
                cardholderVerificationMethodResults
                applicationTransactionCounter
                unpredictableNumber
                issuerActionCodeDefault
                issuerActionCodeDenial
                issuerActionCodeOnline
                readerId
                storeId
              }
            }
          }
          billingAddress {
            company
            addressLine1
            addressLine2
            fullName
            adminArea2
            adminArea1
            postalCode
            countryCode
            phone {
              countryPhoneCode
              phoneNumber
              extensionNumber
            }
          }
          threeDSecure {
            authentication {
              cavv
              directoryServerTransactionId
              eciFlag
              liabilityShifted
              liabilityShiftPossible
              cardEnrolled
              authenticationStatus
              version
              xId
              threeDSecureServerTransactionId
              acsTransactionId
              paresStatus
              transactionStatus
              transactionStatusReason
            }
          }
          cardOnFileNetworkTokenized
          paymentAccountReference
        }
        ... on PayPalTransactionDetails {
          __typename
          authorizationId
          captureId
          customField
          payer {
            __typename
            billingAgreementId
            billingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            shippingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            email
            phone
            payerId
            firstName
            lastName
            cobrandedCardLabel
            origin {
              type
              details {
                __typename
                ... on ApplePayOriginDetails {
                  __typename
                  paymentInstrumentName
                  bin
                  merchantTokenIdentifier
                  dpanLastTwo
                  isDeviceToken
                  last4
                  paymentAccountReference
                }
                ... on GooglePayOriginDetails {
                  __typename
                  googleTransactionId
                  bin
                  last4
                  paymentAccountReference
                }
                ... on MasterpassOriginDetails {
                  __typename
                  bin
                }
                ... on MetaCheckoutOriginDetails {
                  __typename
                  containerId
                  bin
                }
                ... on NetworkTokenOriginDetails {
                  __typename
                  bin
                }
                ... on SamsungPayOriginDetails {
                  __typename
                  bin
                }
                ... on VisaCheckoutOriginDetails {
                  __typename
                  callId
                  bin
                }
                ... on PayPalLocalPaymentOriginDetails {
                  __typename
                  captureId
                  customField
                  paymentId
                  transactionFee {
                    value
                    currencyCode
                  }
                  blikAliases {
                    key
                    label
                  }
                }
                ... on CardPresentOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  readerId
                  storeId
                }
                ... on EmvCardOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  applicationPreferredName
                  applicationIdentifier
                  terminalVerificationResult
                  cardSequenceNumber
                  applicationInterchangeProfile
                  terminalTransactionDate
                  terminalTransactionType
                  cashbackAmount
                  applicationUsageControl
                  terminalCountryCode
                  applicationCryptogram
                  cryptogramInformationData
                  cardholderVerificationMethodResults
                  applicationTransactionCounter
                  unpredictableNumber
                  issuerActionCodeDefault
                  issuerActionCodeDenial
                  issuerActionCodeOnline
                  readerId
                  storeId
                }
              }
            }
            limitedUseOrderId
            selectedFinancingOption {
              term
              monthlyPayment {
                value
                currencyCode
              }
              discountPercentage
              discountAmount {
                value
                currencyCode
              }
            }
            fundingSourceDescription
            vaultedBillingAgreementId
          }
          payee {
            __typename
            billingAgreementId
            billingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            shippingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            email
            phone
            payerId
            firstName
            lastName
            cobrandedCardLabel
            origin {
              type
              details {
                __typename
                ... on ApplePayOriginDetails {
                  __typename
                  paymentInstrumentName
                  bin
                  merchantTokenIdentifier
                  dpanLastTwo
                  isDeviceToken
                  last4
                  paymentAccountReference
                }
                ... on GooglePayOriginDetails {
                  __typename
                  googleTransactionId
                  bin
                  last4
                  paymentAccountReference
                }
                ... on MasterpassOriginDetails {
                  __typename
                  bin
                }
                ... on MetaCheckoutOriginDetails {
                  __typename
                  containerId
                  bin
                }
                ... on NetworkTokenOriginDetails {
                  __typename
                  bin
                }
                ... on SamsungPayOriginDetails {
                  __typename
                  bin
                }
                ... on VisaCheckoutOriginDetails {
                  __typename
                  callId
                  bin
                }
                ... on PayPalLocalPaymentOriginDetails {
                  __typename
                  captureId
                  customField
                  paymentId
                  transactionFee {
                    value
                    currencyCode
                  }
                  blikAliases {
                    key
                    label
                  }
                }
                ... on CardPresentOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  readerId
                  storeId
                }
                ... on EmvCardOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  applicationPreferredName
                  applicationIdentifier
                  terminalVerificationResult
                  cardSequenceNumber
                  applicationInterchangeProfile
                  terminalTransactionDate
                  terminalTransactionType
                  cashbackAmount
                  applicationUsageControl
                  terminalCountryCode
                  applicationCryptogram
                  cryptogramInformationData
                  cardholderVerificationMethodResults
                  applicationTransactionCounter
                  unpredictableNumber
                  issuerActionCodeDefault
                  issuerActionCodeDenial
                  issuerActionCodeOnline
                  readerId
                  storeId
                }
              }
            }
            limitedUseOrderId
            selectedFinancingOption {
              term
              monthlyPayment {
                value
                currencyCode
              }
              discountPercentage
              discountAmount {
                value
                currencyCode
              }
            }
            fundingSourceDescription
            vaultedBillingAgreementId
          }
          payerStatus
          paymentId
          sellerProtectionStatus
          taxId
          taxIdType
          transactionFee {
            value
            currencyCode
          }
          description
          origin {
            type
            details {
              __typename
              ... on ApplePayOriginDetails {
                __typename
                paymentInstrumentName
                bin
                merchantTokenIdentifier
                dpanLastTwo
                isDeviceToken
                last4
                paymentAccountReference
              }
              ... on GooglePayOriginDetails {
                __typename
                googleTransactionId
                bin
                last4
                paymentAccountReference
              }
              ... on MasterpassOriginDetails {
                __typename
                bin
              }
              ... on MetaCheckoutOriginDetails {
                __typename
                containerId
                bin
              }
              ... on NetworkTokenOriginDetails {
                __typename
                bin
              }
              ... on SamsungPayOriginDetails {
                __typename
                bin
              }
              ... on VisaCheckoutOriginDetails {
                __typename
                callId
                bin
              }
              ... on PayPalLocalPaymentOriginDetails {
                __typename
                captureId
                customField
                paymentId
                transactionFee {
                  value
                  currencyCode
                }
                blikAliases {
                  key
                  label
                }
              }
              ... on CardPresentOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                readerId
                storeId
              }
              ... on EmvCardOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                applicationPreferredName
                applicationIdentifier
                terminalVerificationResult
                cardSequenceNumber
                applicationInterchangeProfile
                terminalTransactionDate
                terminalTransactionType
                cashbackAmount
                applicationUsageControl
                terminalCountryCode
                applicationCryptogram
                cryptogramInformationData
                cardholderVerificationMethodResults
                applicationTransactionCounter
                unpredictableNumber
                issuerActionCodeDefault
                issuerActionCodeDenial
                issuerActionCodeOnline
                readerId
                storeId
              }
            }
          }
          appUsedForScanning
          recipientEmail
          recipientPhone {
            countryPhoneCode
            phoneNumber
            extensionNumber
          }
        }
        ... on VenmoAccountDetails {
          __typename
          username
          venmoUserId
        }
        ... on UsBankAccountDetails {
          __typename
          accountholderName
          usBankAccountType: accountType
          ownershipType
          bankName
          last4
          routingNumber
          verified
          achMandate {
            acceptedAt
          }
        }
        ... on LocalPaymentDetails {
          __typename
          origin {
            type
            details {
              __typename
              ... on ApplePayOriginDetails {
                __typename
                paymentInstrumentName
                bin
                merchantTokenIdentifier
                dpanLastTwo
                isDeviceToken
                last4
                paymentAccountReference
              }
              ... on GooglePayOriginDetails {
                __typename
                googleTransactionId
                bin
                last4
                paymentAccountReference
              }
              ... on MasterpassOriginDetails {
                __typename
                bin
              }
              ... on MetaCheckoutOriginDetails {
                __typename
                containerId
                bin
              }
              ... on NetworkTokenOriginDetails {
                __typename
                bin
              }
              ... on SamsungPayOriginDetails {
                __typename
                bin
              }
              ... on VisaCheckoutOriginDetails {
                __typename
                callId
                bin
              }
              ... on PayPalLocalPaymentOriginDetails {
                __typename
                captureId
                customField
                paymentId
                transactionFee {
                  value
                  currencyCode
                }
                blikAliases {
                  key
                  label
                }
              }
              ... on CardPresentOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                readerId
                storeId
              }
              ... on EmvCardOriginDetails {
                __typename
                authorizationMode
                pinVerified
                inputMode
                terminalId
                applicationPreferredName
                applicationIdentifier
                terminalVerificationResult
                cardSequenceNumber
                applicationInterchangeProfile
                terminalTransactionDate
                terminalTransactionType
                cashbackAmount
                applicationUsageControl
                terminalCountryCode
                applicationCryptogram
                cryptogramInformationData
                cardholderVerificationMethodResults
                applicationTransactionCounter
                unpredictableNumber
                issuerActionCodeDefault
                issuerActionCodeDenial
                issuerActionCodeOnline
                readerId
                storeId
              }
            }
          }
          type
          displayName
          implicitlyVaultedPaymentMethodId
        }
        ... on CreditCardTransactionDetails {
          __typename
          creditCard {
            __typename
            brandCode
            last4
            bin
            binData {
              prepaid
              healthcare
              debit
              durbinRegulated
              commercial
              payroll
              issuingBank
              countryOfIssuance
              productId
              prepaidReloadable
              business
              consumer
              corporate
              purchase
            }
            expirationMonth
            expirationYear
            cardholderName
            uniqueNumberIdentifier
            origin {
              type
              details {
                __typename
                ... on ApplePayOriginDetails {
                  __typename
                  paymentInstrumentName
                  bin
                  merchantTokenIdentifier
                  dpanLastTwo
                  isDeviceToken
                  last4
                  paymentAccountReference
                }
                ... on GooglePayOriginDetails {
                  __typename
                  googleTransactionId
                  bin
                  last4
                  paymentAccountReference
                }
                ... on MasterpassOriginDetails {
                  __typename
                  bin
                }
                ... on MetaCheckoutOriginDetails {
                  __typename
                  containerId
                  bin
                }
                ... on NetworkTokenOriginDetails {
                  __typename
                  bin
                }
                ... on SamsungPayOriginDetails {
                  __typename
                  bin
                }
                ... on VisaCheckoutOriginDetails {
                  __typename
                  callId
                  bin
                }
                ... on PayPalLocalPaymentOriginDetails {
                  __typename
                  captureId
                  customField
                  paymentId
                  transactionFee {
                    value
                    currencyCode
                  }
                  blikAliases {
                    key
                    label
                  }
                }
                ... on CardPresentOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  readerId
                  storeId
                }
                ... on EmvCardOriginDetails {
                  __typename
                  authorizationMode
                  pinVerified
                  inputMode
                  terminalId
                  applicationPreferredName
                  applicationIdentifier
                  terminalVerificationResult
                  cardSequenceNumber
                  applicationInterchangeProfile
                  terminalTransactionDate
                  terminalTransactionType
                  cashbackAmount
                  applicationUsageControl
                  terminalCountryCode
                  applicationCryptogram
                  cryptogramInformationData
                  cardholderVerificationMethodResults
                  applicationTransactionCounter
                  unpredictableNumber
                  issuerActionCodeDefault
                  issuerActionCodeDenial
                  issuerActionCodeOnline
                  readerId
                  storeId
                }
              }
            }
            billingAddress {
              company
              addressLine1
              addressLine2
              fullName
              adminArea2
              adminArea1
              postalCode
              countryCode
              phone {
                countryPhoneCode
                phoneNumber
                extensionNumber
              }
            }
            threeDSecure {
              authentication {
                cavv
                directoryServerTransactionId
                eciFlag
                liabilityShifted
                liabilityShiftPossible
                cardEnrolled
                authenticationStatus
                version
                xId
                threeDSecureServerTransactionId
                acsTransactionId
                paresStatus
                transactionStatus
                transactionStatusReason
              }
            }
            cardOnFileNetworkTokenized
            paymentAccountReference
          }
          networkTransactionId
          creditCardTransactionAccountType: accountType
          acquirerReferenceNumber
          processedWithCardOnFileNetworkToken
          accountBalance {
            value
            currencyCode
          }
        }
        ... on SEPADirectDebitTransactionDetails {
          __typename
          captureId
          transactionFee {
            value
            currencyCode
          }
          paymentId
        }
        ... on UsBankAccountTransactionDetails {
          __typename
          usBankAccount {
            __typename
            accountholderName
            accountType
            ownershipType
            bankName
            last4
            routingNumber
            verified
            achMandate {
              acceptedAt
            }
          }
          achType
          requestedAchType
        }
      }
      paymentMethod {
        __typename
        id
        legacyId
      }
      customer {
        __typename
        id
        legacyId
      }
      surchargeAmount
      lineItems {
        name
        kind
        quantity
        unitAmount
        totalAmount
        unitTaxAmount
        taxAmount
        discountAmount
        unitOfMeasure
        productCode
        commodityCode
        description
        url
        itemType
        imageUrl
        upc {
          upcCode
          upcType
        }
      }
      customFields {
        name
        value
      }
      descriptor {
        name
        phone
        url
      }
      disbursementDetails {
        date
        amount {
          value
          currencyCode
        }
        exchangeRate
        fundsHeld
      }
      paymentInitiatedAt
      merchantId
    }
  }
}
```

---

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