openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Transaction API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Transaction
paths:
  /data/v64.0/connect/fundraising/transactions/payment-updates:
    parameters: []
    post:
      tags:
      - Transaction
      summary: Salesforce Update Gift Transaction Payments
      description: "Update the gateway and processor metadata for gift transactions.\n\n## Required Attributes:\n\n- giftTransactionId\n    \n- transactionStatus"
      operationId: UpdateGiftTransactionPayments
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateGiftTransactionPaymentsRequest'
              - examples:
                - updates:
                  - giftTransactionId: <SFDC_GIFT_TRANSACTION_ID>
                    transactionStatus: Paid
                    processorReference: string
                    gatewayReference: string
                    lastGatewayResponseCode: invalid_cvc
                    lastGatewayErrorMessage: The card’s security code is invalid. Check the card’s security code or use a different card.
                    lastGatewayProcessedDateTime: '2023-07-06T21:57:51.000Z'
                    processorTransactionFee: 0.5
                    gatewayTransactionFee: 0.25
                    donorCoverAmount: 10.5
                  - giftTransactionId: <SFDC_GIFT_TRANSACTION_ID>
                    transactionStatus: Paid
                    processorReference: string
                    gatewayReference: string
                    lastGatewayResponseCode: invalid_cvc
                    lastGatewayErrorMessage: The card’s security code is invalid. Check the card’s security code or use a different card.
                    lastGatewayProcessedDateTime: '2023-07-06T21:57:51.000Z'
                    processorTransactionFee: 1
                    gatewayTransactionFee: 0.45
                    donorCoverAmount: 20
              contentMediaType: application/json
            example:
              updates:
              - giftTransactionId: <SFDC_GIFT_TRANSACTION_ID>
                transactionStatus: Paid
                processorReference: string
                gatewayReference: string
                lastGatewayResponseCode: invalid_cvc
                lastGatewayErrorMessage: The card’s security code is invalid. Check the card’s security code or use a different card.
                lastGatewayProcessedDateTime: '2023-07-06T21:57:51.000Z'
                processorTransactionFee: 0.5
                gatewayTransactionFee: 0.25
                donorCoverAmount: 10.5
              - giftTransactionId: <SFDC_GIFT_TRANSACTION_ID>
                transactionStatus: Paid
                processorReference: string
                gatewayReference: string
                lastGatewayResponseCode: invalid_cvc
                lastGatewayErrorMessage: The card’s security code is invalid. Check the card’s security code or use a different card.
                lastGatewayProcessedDateTime: '2023-07-06T21:57:51.000Z'
                processorTransactionFee: 1
                gatewayTransactionFee: 0.45
                donorCoverAmount: 20
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Status201-UpdateTransactionPaymentSuccess'
                - examples:
                  - successes: 2
                    failures: 0
                    notProcessed: 0
                    details:
                    - success: true
                      links:
                        gifttransaction:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
                          id: <SFDC_GIFT_TRANSACTION_ID>
                    - success: true
                      links:
                        gifttransaction:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
                          id: <SFDC_GIFT_TRANSACTION_ID>
                contentMediaType: application/json
              example:
                successes: 2
                failures: 0
                notProcessed: 0
                details:
                - success: true
                  links:
                    gifttransaction:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
                      id: <SFDC_GIFT_TRANSACTION_ID>
                - success: true
                  links:
                    gifttransaction:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
                      id: <SFDC_GIFT_TRANSACTION_ID>
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Status201-UpdateTransactionPaymentWithExternalIds1'
                - examples:
                  - successes: 1
                    failures: 0
                    notProcessed: 0
                    details:
                    - success: true
                      links:
                        gifttransaction:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
                          id: <SFDC_GIFT_TRANSACTION_ID>
                contentMediaType: application/json
              example:
                successes: 1
                failures: 0
                notProcessed: 0
                details:
                - success: true
                  links:
                    gifttransaction:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
                      id: <SFDC_GIFT_TRANSACTION_ID>
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/connect/loyalty/programs/{loyaltyProgramName}/transaction-history:
    parameters: []
    post:
      tags:
      - Transaction
      summary: Salesforce Transaction History
      description: 'Standard Documentation:


        [https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_history.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_history.htm)'
      operationId: TransactionHistory
      parameters:
      - name: page
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: loyaltyProgramName
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TransactionHistoryRequest'
              - examples:
                - membershipNumber: Member1
                  journalType: Accrual
                  journalSubType: Social
                  periodStartDate: '2022-01-27T00:00:00.000Z'
                  periodEndDate: '2022-11-27T00:00:00.000Z'
              contentMediaType: application/json
            example:
              membershipNumber: Member1
              journalType: Accrual
              journalSubType: Social
              periodStartDate: '2022-01-27T00:00:00.000Z'
              periodEndDate: '2022-11-27T00:00:00.000Z'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 May 2024 16:22:05 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/TransactionHistory'
                - examples:
                  - message: null
                    status: true
                    totalCount: 0
                    transactionJournals: []
                contentMediaType: application/json;charset=UTF-8
              example:
                message: null
                status: true
                totalCount: 0
                transactionJournals: []
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/loyalty/programs/{loyaltyProgramName}/members/{membershipNumber}/transaction-ledger-summary:
    parameters: []
    get:
      tags:
      - Transaction
      summary: Salesforce Transaction Ledger Summary
      description: 'Standard Documentation:


        [https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm)'
      operationId: TransactionLedgerSummary
      parameters:
      - name: loyaltyProgramName
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: membershipNumber
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 27 May 2024 19:37:52 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/TransactionLedgerSummary'
                - examples:
                  - message: null
                    status: true
                    transactionJournalCount: 1
                    transactionJournals:
                    - activityDate: '2021-01-01T04:05:05.000Z'
                      additionalTransactionJournalAttributes: []
                      journalSubTypeName: Member Enrollment
                      journalTypeName: Accrual
                      pointsChange: []
                      transactionJournalId: 0lVJ8000000GmaEMAS
                      transactionJournalNumber: 00000008
                contentMediaType: application/json;charset=UTF-8
              example:
                message: null
                status: true
                transactionJournalCount: 1
                transactionJournals:
                - activityDate: '2021-01-01T04:05:05.000Z'
                  additionalTransactionJournalAttributes: []
                  journalSubTypeName: Member Enrollment
                  journalTypeName: Accrual
                  pointsChange: []
                  transactionJournalId: 0lVJ8000000GmaEMAS
                  transactionJournalNumber: 00000008
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/connect/realtime/loyalty/programs/{loyaltyProgramName}:
    parameters: []
    post:
      tags:
      - Transaction
      summary: Salesforce Transaction Journals Execution
      description: 'Standard Documentation:


        [https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm)'
      operationId: TransactionJournalsExecution
      parameters:
      - name: loyaltyProgramName
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TransactionJournalsExecutionRequest'
              - examples:
                - transactionJournals:
                  - ActivityDate: '2023-11-27T12:45:19.000Z'
                    JournalTypeId: 0lERM00000001Bb2AI
                    LoyaltyProgramId: 0lpRM00000002YTYAY
                    MemberId: 0lMRM0000002Fmu2AE
                    Status: Pending
                    appliedPromotions:
                    - promotionId: 0c8RM0000004FiXYAU
                      rewards:
                      - rewardType: Discount
                        discountAmount: 15
                      - rewardType: Points
                        loyaltyProgramCurrencyName: Coins
                        points: 100
                        relatedInformation: Test
                        notes: Test
                      - rewardType: Voucher
                        voucherDefinitionName: 10% Discount Voucher
                        voucherExpirationDate: '2023-12-15T00:00:00.000Z'
                        voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
                        notes: Test
                      - rewardType: Badge
                        loyaltyProgramBadgeName: Gen AI Badge
                        memberBadgeStatus: Active
                        badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
                        reason: Test
                      - rewardType: Game
                        gameDefinitionName: TestGame
              contentMediaType: application/json
            example:
              transactionJournals:
              - ActivityDate: '2023-11-27T12:45:19.000Z'
                JournalTypeId: 0lERM00000001Bb2AI
                LoyaltyProgramId: 0lpRM00000002YTYAY
                MemberId: 0lMRM0000002Fmu2AE
                Status: Pending
                appliedPromotions:
                - promotionId: 0c8RM0000004FiXYAU
                  rewards:
                  - rewardType: Discount
                    discountAmount: 15
                  - rewardType: Points
                    loyaltyProgramCurrencyName: Coins
                    points: 100
                    relatedInformation: Test
                    notes: Test
                  - rewardType: Voucher
                    voucherDefinitionName: 10% Discount Voucher
                    voucherExpirationDate: '2023-12-15T00:00:00.000Z'
                    voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
                    notes: Test
                  - rewardType: Badge
                    loyaltyProgramBadgeName: Gen AI Badge
                    memberBadgeStatus: Active
                    badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
                    reason: Test
                  - rewardType: Game
                    gameDefinitionName: TestGame
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    TransactionJournalsExecutionRequest:
      title: TransactionJournalsExecutionRequest
      required:
      - transactionJournals
      type: object
      properties:
        transactionJournals:
          type: array
          items:
            $ref: '#/components/schemas/TransactionJournal3'
          description: ''
          example: []
      examples:
      - transactionJournals:
        - ActivityDate: '2023-11-27T12:45:19.000Z'
          JournalTypeId: 0lERM00000001Bb2AI
          LoyaltyProgramId: 0lpRM00000002YTYAY
          MemberId: 0lMRM0000002Fmu2AE
          Status: Pending
          appliedPromotions:
          - promotionId: 0c8RM0000004FiXYAU
            rewards:
            - rewardType: Discount
              discountAmount: 15
            - rewardType: Points
              loyaltyProgramCurrencyName: Coins
              points: 100
              relatedInformation: Test
              notes: Test
            - rewardType: Voucher
              voucherDefinitionName: 10% Discount Voucher
              voucherExpirationDate: '2023-12-15T00:00:00.000Z'
              voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
              notes: Test
            - rewardType: Badge
              loyaltyProgramBadgeName: Gen AI Badge
              memberBadgeStatus: Active
              badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
              reason: Test
            - rewardType: Game
              gameDefinitionName: TestGame
    UpdateGiftTransactionPaymentsRequest:
      title: UpdateGiftTransactionPaymentsRequest
      required:
      - updates
      type: object
      properties:
        updates:
          type: array
          items:
            $ref: '#/components/schemas/Update'
          description: ''
          example: []
      examples:
      - updates:
        - giftTransactionId: <SFDC_GIFT_TRANSACTION_ID>
          transactionStatus: Paid
          processorReference: string
          gatewayReference: string
          lastGatewayResponseCode: invalid_cvc
          lastGatewayErrorMessage: The card’s security code is invalid. Check the card’s security code or use a different card.
          lastGatewayProcessedDateTime: '2023-07-06T21:57:51.000Z'
          processorTransactionFee: 0.5
          gatewayTransactionFee: 0.25
          donorCoverAmount: 10.5
        - giftTransactionId: <SFDC_GIFT_TRANSACTION_ID>
          transactionStatus: Paid
          processorReference: string
          gatewayReference: string
          lastGatewayResponseCode: invalid_cvc
          lastGatewayErrorMessage: The card’s security code is invalid. Check the card’s security code or use a different card.
          lastGatewayProcessedDateTime: '2023-07-06T21:57:51.000Z'
          processorTransactionFee: 1
          gatewayTransactionFee: 0.45
          donorCoverAmount: 20
    AppliedPromotion:
      title: AppliedPromotion
      required:
      - promotionId
      - rewards
      type: object
      properties:
        promotionId:
          type: string
          example: '500123'
        rewards:
          type: array
          items:
            $ref: '#/components/schemas/Reward'
          description: ''
          example: []
      examples:
      - promotionId: 0c8RM0000004FiXYAU
        rewards:
        - rewardType: Discount
          discountAmount: 15
        - rewardType: Points
          loyaltyProgramCurrencyName: Coins
          points: 100
          relatedInformation: Test
          notes: Test
        - rewardType: Voucher
          voucherDefinitionName: 10% Discount Voucher
          voucherExpirationDate: '2023-12-15T00:00:00.000Z'
          voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
          notes: Test
        - rewardType: Badge
          loyaltyProgramBadgeName: Gen AI Badge
          memberBadgeStatus: Active
          badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
          reason: Test
        - rewardType: Game
          gameDefinitionName: TestGame
    TransactionHistoryRequest:
      title: TransactionHistoryRequest
      required:
      - membershipNumber
      - journalType
      - journalSubType
      - periodStartDate
      - periodEndDate
      type: object
      properties:
        membershipNumber:
          type: string
          example: example_value
        journalType:
          type: string
          example: example_value
        journalSubType:
          type: string
          example: example_value
        periodStartDate:
          type: string
          example: example_value
        periodEndDate:
          type: string
          example: example_value
      examples:
      - membershipNumber: Member1
        journalType: Accrual
        journalSubType: Social
        periodStartDate: '2022-01-27T00:00:00.000Z'
        periodEndDate: '2022-11-27T00:00:00.000Z'
    TransactionLedgerSummary:
      title: TransactionLedgerSummary
      required:
      - message
      - status
      - transactionJournalCount
      - transactionJournals
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          example: example_value
        status:
          type: boolean
          example: true
        transactionJournalCount:
          type: integer
          contentEncoding: int32
          example: 42
        transactionJournals:
          type: array
          items:
            $ref: '#/components/schemas/TransactionJournal2'
          description: ''
          example: []
      examples:
      - message: null
        status: true
        transactionJournalCount: 1
        transactionJournals:
        - activityDate: '2021-01-01T04:05:05.000Z'
          additionalTransactionJournalAttributes: []
          journalSubTypeName: Member Enrollment
          journalTypeName: Accrual
          pointsChange: []
          transactionJournalId: 0lVJ8000000GmaEMAS
          transactionJournalNumber: 00000008
    TransactionHistory:
      title: TransactionHistory
      required:
      - message
      - status
      - totalCount
      - transactionJournals
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          example: example_value
        status:
          type: boolean
          example: true
        totalCount:
          type: integer
          contentEncoding: int32
          example: 42
        transactionJournals:
          type: array
          items:
            type: string
          description: ''
          example: []
      examples:
      - message: null
        status: true
        totalCount: 0
        transactionJournals: []
    TransactionJournal3:
      title: TransactionJournal3
      required:
      - ActivityDate
      - JournalTypeId
      - LoyaltyProgramId
      - MemberId
      - Status
      - appliedPromotions
      type: object
      properties:
        ActivityDate:
          type: string
          example: example_value
        JournalTypeId:
          type: string
          example: '500123'
        LoyaltyProgramId:
          type: string
          example: '500123'
        MemberId:
          type: string
          example: '500123'
        Status:
          type: string
          example: example_value
        appliedPromotions:
          type: array
          items:
            $ref: '#/components/schemas/AppliedPromotion'
          description: ''
          example: []
      examples:
      - ActivityDate: '2023-11-27T12:45:19.000Z'
        JournalTypeId: 0lERM00000001Bb2AI
        LoyaltyProgramId: 0lpRM00000002YTYAY
        MemberId: 0lMRM0000002Fmu2AE
        Status: Pending
        appliedPromotions:
        - promotionId: 0c8RM0000004FiXYAU
          rewards:
          - rewardType: Discount
            discountAmount: 15
          - rewardType: Points
            loyaltyProgramCurrencyName: Coins
            points: 100
            relatedInformation: Test
            notes: Test
          - rewardType: Voucher
            voucherDefinitionName: 10% Discount Voucher
            voucherExpirationDate: '2023-12-15T00:00:00.000Z'
            voucherEffectiveDate: '2023-11-29T00:00:00.000Z'
            notes: Test
          - rewardType: Badge
            loyaltyProgramBadgeName: Gen AI Badge
            memberBadgeStatus: Active
            badgeValidityEndDate: '2023-12-15T00:00:00.000Z'
            reason: Test
          - rewardType: Game
            gameDefinitionName: TestGame
    Detail3:
      title: Detail3
      required:
      - success
      - links
      type: object
      properties:
        success:
          type: boolean
          example: true
        links:
          $ref: '#/components/schemas/Links3'
      examples:
      - success: true
        links:
          gifttransaction:
            href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
            id: <SFDC_GIFT_TRANSACTION_ID>
    Reward:
      title: Reward
      required:
      - rewardType
      type: object
      properties:
        rewardType:
          type: string
          example: example_value
        discountAmount:
          type: integer
          contentEncoding: int32
          example: 42
        loyaltyProgramCurrencyName:
          type: string
          example: example_value
        points:
          type: integer
          contentEncoding: int32
          example: 10
        relatedInformation:
          type: string
          example: example_value
        notes:
          type: string
          example: example_value
        voucherDefinitionName:
          type: string
          example: example_value
        voucherExpirationDate:
          type: string
          example: example_value
        voucherEffectiveDate:
          type: string
          example: example_value
        loyaltyProgramBadgeName:
          type: string
          example: example_value
        memberBadgeStatus:
          type: string
          example: example_value
        badgeValidityEndDate:
          type: string
          example: example_value
        reason:
          type: string
          example: example_value
        gameDefinitionName:
          type: string
          example: example_value
      examples:
      - rewardType: Discount
        discountAmount: 15
    Status201-UpdateTransactionPaymentSuccess:
      title: Status201-UpdateTransactionPaymentSuccess
      required:
      - successes
      - failures
      - notProcessed
      - details
      type: object
      properties:
        successes:
          type: integer
          contentEncoding: int32
          example: 10
        failures:
          type: integer
          contentEncoding: int32
          example: 10
        notProcessed:
          type: integer
          contentEncoding: int32
          example: 10
        details:
          type: array
          items:
            $ref: '#/components/schemas/Detail3'
          description: ''
          example: []
      examples:
      - successes: 2
        failures: 0
        notProcessed: 0
        details:
        - success: true
          links:
            gifttransaction:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
              id: <SFDC_GIFT_TRANSACTION_ID>
        - success: true
          links:
            gifttransaction:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
              id: <SFDC_GIFT_TRANSACTION_ID>
    Update:
      title: Update
      required:
      - giftTransactionId
      - transactionStatus
      - processorReference
      - gatewayReference
      - lastGatewayResponseCode
      - lastGatewayErrorMessage
      - lastGatewayProcessedDateTime
      - processorTransactionFee
      - gatewayTransactionFee
      - donorCoverAmount
      type: object
      properties:
        giftTransactionId:
          type: string
          example: '500123'
        transactionStatus:
          type: string
          example: example_value
        processorReference:
          type: string
          example: example_value
        gatewayReference:
          type: string
          example: example_value
        lastGatewayResponseCode:
          type: string
          example: example_value
        lastGatewayErrorMessage:
          type: string
          example: example_value
        lastGatewayProcessedDateTime:
          type: string
          example: '2026-01-15T10:30:00Z'
        processorTransactionFee:
          type: number
          example: 42.5
        gatewayTransactionFee:
          type: number
          example: 42.5
        donorCoverAmount:
          type: number
          example: 42.5
      examples:
      - giftTransactionId: <SFDC_GIFT_TRANSACTION_ID>
        transactionStatus: Paid
        processorReference: string
        gatewayReference: string
        lastGatewayResponseCode: invalid_cvc
        lastGatewayErrorMessage: The card’s security code is invalid. Check the card’s security code or use a different card.
        lastGatewayProcessedDateTime: '2023-07-06T21:57:51.000Z'
        processorTransactionFee: 0.5
        gatewayTransactionFee: 0.25
        donorCoverAmount: 10.5
    Gifttransaction:
      title: Gifttransaction
      required:
      - href
      - id
      type: object
      properties:
        href:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
      examples:
      - href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
        id: <SFDC_GIFT_TRANSACTION_ID>
    Status201-UpdateTransactionPaymentWithExternalIds1:
      title: Status201-UpdateTransactionPaymentWithExternalIds1
      required:
      - successes
      - failures
      - notProcessed
      - details
      type: object
      properties:
        successes:
          type: integer
          contentEncoding: int32
          example: 10
        failures:
          type: integer
          contentEncoding: int32
          example: 10
        notProcessed:
          type: integer
          contentEncoding: int32
          example: 10
        details:
          type: array
          items:
            $ref: '#/components/schemas/Detail3'
          description: ''
          example: []
      examples:
      - successes: 1
        failures: 0
        notProcessed: 0
        details:
        - success: true
          links:
            gifttransaction:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
              id: <SFDC_GIFT_TRANSACTION_ID>
    Links3:
      title: Links3
      required:
      - gifttransaction
      type: object
      properties:
        gifttransaction:
          $ref: '#/components/schemas/Gifttransaction'
      examples:
      - gifttransaction:
          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>
          id: <SFDC_GIFT_TRANSACTION_ID>
    TransactionJournal2:
      title: TransactionJournal2
      required:
      - activityDate
      - additionalTransactionJournalAttributes
      - journalSubTypeName
      - journalTypeName
      - pointsChange
      - transactionJournalId
      - transactionJournalNumber
      type: object
      properties:
        activityDate:
          type: string
          example: example_value
        additionalTransactionJournalAttributes:
          type: array
          items:
            type: string
          description: ''
          example: []
        journalSubTypeName:
          type: string
          example: example_value
        journalTypeName:
          type: string
          example: example_value
        pointsChange:
          type: array
          items:
            type: string
          description: ''
          example: []
        transactionJournalId:
          type: string
          example: '500123'
        transactionJournalNumber:
          type: string
          example: example_value
      examples:
      - activityDate: '2021-01-01T04:05:05.000Z'
        additionalTransactionJournalAttributes: []
        journalSubTypeName: Member Enrollment
        journalTypeName: Accrual
        pointsChange: []
        transactionJournalId: 0lVJ8000000GmaEMAS
        transactionJournalNumber: 00000008
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '