generated: '2026-09-09' method: derived source: https://github.com/GBSEcom/Python — docs/*.md model reference generated by First Data from the First Data Gateway (IPG) v2 specification, API version 21.5.0. note: Derived by parsing the model reference First Data publishes with its own Python SDK. The gateway serves no OpenAPI at a reachable URL, so the SDK's generated model docs are the closest first-party rendering of the schema graph that exists in public. 340 model documents were read; 203 declare at least one typed reference to another model. Only the core transaction/order/token/schedule entities are expanded below. model_count: 340 models_with_relationships: 203 root_entities: - name: Transaction identifier: transaction-id operations: - POST /payments - GET /payments/{transaction-id} - POST /payments/{transaction-id} - PATCH /payments/{transaction-id} - name: Order identifier: order-id operations: - GET /orders/{order-id} - POST /orders/{order-id} - name: PaymentToken identifier: token-id operations: - POST /payment-tokens - GET /payment-tokens/{token-id} - PATCH /payment-tokens - DELETE /payment-tokens/{token-id} - name: PaymentSchedule identifier: order-id operations: - POST /payment-schedules - GET /payment-schedules/{order-id} - PATCH /payment-schedules/{order-id} - DELETE /payment-schedules/{order-id} - name: PaymentUrl identifier: null operations: - POST /payment-url - GET /payment-url - DELETE /payment-url entities: - name: PaymentCardSaleTransaction relationships: - via: payment_method to: PaymentCardPaymentMethod kind: has_one - via: stored_credentials to: StoredCredential kind: has_one - via: settlement_split to: SubMerchantSplit kind: has_many - via: create_token to: CreatePaymentToken kind: has_one - via: currency_conversion to: CurrencyConversion kind: has_one - via: authentication_request to: AuthenticationRequest kind: has_one - via: authentication_result to: AuthenticationResult kind: has_one - name: PaymentCardPreAuthTransaction relationships: - via: payment_method to: PaymentCardPaymentMethod kind: has_one - via: stored_credentials to: StoredCredential kind: has_one - via: create_token to: CreatePaymentToken kind: has_one - via: split_shipment to: SplitShipment kind: has_one - via: settlement_split to: SubMerchantSplit kind: has_many - via: authentication_request to: AuthenticationRequest kind: has_one - via: authentication_result to: AuthenticationResult kind: has_one - name: TransactionResponse relationships: - via: response_type to: ResponseType kind: has_one - via: transaction_type to: TransactionType kind: has_one - via: payment_token to: PaymentTokenDetails kind: has_one - via: transaction_origin to: TransactionOrigin kind: has_one - via: payment_method_details to: PaymentMethodDetails kind: has_one - via: approved_amount to: Amount kind: has_one - via: secure3d_response to: Secure3dResponse kind: has_one - via: standin_response_details to: StandinResponseDetails kind: has_one - via: authentication_response to: Secure3DAuthenticationResponse kind: has_one - via: processor to: ProcessorData kind: has_one - via: additional_details to: AdditionalTransactionDetails kind: has_one - via: account_updater_response to: AccountUpdaterResponse kind: has_one - via: ach_response to: AchResponse kind: has_one - via: currency_conversion_response to: CurrencyConversionResponse kind: has_one - via: steps to: PaymentStepRequest kind: has_many - name: TransactionErrorResponse relationships: - via: response_type to: ResponseType kind: has_one - via: transaction_type to: TransactionType kind: has_one - via: payment_token to: PaymentTokenDetails kind: has_one - via: transaction_origin to: TransactionOrigin kind: has_one - via: payment_method_details to: PaymentMethodDetails kind: has_one - via: approved_amount to: Amount kind: has_one - via: secure3d_response to: Secure3dResponse kind: has_one - via: standin_response_details to: StandinResponseDetails kind: has_one - via: authentication_response to: Secure3DAuthenticationResponse kind: has_one - via: processor to: ProcessorData kind: has_one - via: additional_details to: AdditionalTransactionDetails kind: has_one - via: account_updater_response to: AccountUpdaterResponse kind: has_one - via: ach_response to: AchResponse kind: has_one - via: currency_conversion_response to: CurrencyConversionResponse kind: has_one - via: steps to: PaymentStepRequest kind: has_many - via: error to: Error kind: has_one - name: Order relationships: - via: billing to: Billing kind: has_one - via: shipping to: Shipping kind: has_one - via: industry_specific_extensions to: IndustrySpecificExtensions kind: has_one - via: purchase_card to: PurchaseCards kind: has_one - via: installment_options to: InstallmentOptions kind: has_one - via: revolving_options to: RevolvingOptions kind: has_one - via: stand_in_details to: StandInDetails kind: has_one - via: soft_descriptor to: SoftDescriptor kind: has_one - via: additional_details to: AdditionalDetails kind: has_one - via: bancontact_qr to: BancontactQR kind: has_one - via: client_locale to: ClientLocale kind: has_one - name: OrderResponse relationships: - via: response_type to: ResponseType kind: has_one - via: billing to: Billing kind: has_one - via: shipping to: Shipping kind: has_one - via: transactions to: TransactionResponse kind: has_many - via: additional_details to: AdditionalDetails kind: has_one - name: PaymentSchedulesRequest relationships: - via: transaction_origin to: TransactionOrigin kind: has_one - via: frequency to: Frequency kind: has_one - via: transaction_amount to: Amount kind: has_one - via: client_locale to: ClientLocale kind: has_one - via: billing to: Billing kind: has_one - via: shipping to: Shipping kind: has_one - name: PaymentSchedulesResponse relationships: - via: response_type to: ResponseType kind: has_one - via: transaction_response to: TransactionResponse kind: has_one - name: PaymentTokenizationRequest relationships: - via: billing_address to: Address kind: has_one - via: create_token to: CreatePaymentToken kind: has_one - via: additional_details to: AdditionalDetails kind: has_one - name: PaymentTokenizationResponse relationships: - via: response_type to: ResponseType kind: has_one - via: payment_token to: PaymentTokenDetails kind: has_one - via: payment_card to: PaymentCard kind: has_one - via: processor to: ProcessorData kind: has_one - via: additional_response_data to: AdditionalResponseData kind: has_one - name: PaymentUrlRequest relationships: - via: client_locale to: ClientLocale kind: has_one - via: transaction_amount to: Amount kind: has_one - via: transaction_type to: TransactionType kind: has_one - via: billing to: Billing kind: has_one - via: shipping to: Shipping kind: has_one - via: revolving_options to: RevolvingOptions kind: has_one - via: installment_options to: InstallmentOptions kind: has_one - via: basket to: Basket kind: has_one - name: PaymentUrlResponse relationships: - via: response_type to: ResponseType kind: has_one - name: Amount relationships: - via: components to: AmountComponents kind: has_one - name: Billing relationships: - via: contact to: Contact kind: has_one - via: address to: Address kind: has_one - name: Shipping relationships: - via: contact to: Contact kind: has_one - via: address to: Address kind: has_one - name: Basket relationships: - via: items to: BasketItem kind: has_many - name: Customer relationships: - via: address to: CustomerAddress kind: has_one - name: Merchant relationships: - via: location to: Location kind: has_one - name: PaymentCard relationships: - via: expiry_date to: Expiration kind: has_one - via: card_function to: CardFunction kind: has_one - name: ProcessorData relationships: - via: avs_response to: AVSResponse kind: has_one - via: cardholder_info_response to: CardholderInfoResponse kind: has_one - name: AchSaleTransaction relationships: - via: payment_method to: TeleCheckAchPaymentMethod kind: has_one - name: ErrorResponse relationships: - via: response_type to: ResponseType kind: has_one - via: error to: Error kind: has_one - name: Error relationships: - via: details to: ErrorDetails kind: has_many gaps: - No id-prefix scheme is published for transaction-id, order-id or token-id. - No collection-listing operation exists, so the graph has no traversal entry point other than an id the caller already holds.