Inttegro PHP SDK

Application

Classes

App: An Inttegro application, including its identity, lifecycle timestamps, credentials, and organization relationship.
Relationship: Relationship receipt for the created child app.
RelationshipPolicy: Optional direct-placement relationship policy. Omitted values default to parent management and child credentials.
SecretKey: Secret Key details associated with app.
Balance: The authenticated application's latest balance snapshot, keyed by supported currency.
CurrencySnapshot: Currency Snapshot details associated with balance.
CurrencySnapshotRefund: Currency Snapshot Refund details associated with balance.
CurrencySnapshotReserved: Currency Snapshot Reserved details associated with balance.
Value: Value details associated with balance.
AllocationUse: Refund or payout reference and amount consumed from one balance transaction.
Amount: Amount details associated with balance transaction.
BalanceTransaction: A ledger entry that explains when and why money moved through an Inttegro balance.
Page: A page of balance transaction values together with pagination metadata.
PayoutAllocation: Caller-safe allocation of part of a payment balance transaction to a payout.
RefundAllocation: Caller-safe allocation of part of a payment balance transaction to a refund.
BankAccount: Bank-account details used by payment methods and financial accounts.
Ghana: Ghana details associated with bank account.
Owner: Owner details to patch onto the payment method.
OwnerAddress: Postal address details associated with bank account.
Broadcast: A multi-recipient message broadcast together with its creation, cancellation, and delivery state.
CancelDetail: Cancel Detail details associated with broadcast.
CreationDetail: Creation Detail details associated with broadcast.
Error: Error encountered when broadcasting to a specific recipient.
Chime: A notification message and its recipient, transport, content, and delivery history.
EmailEvent: Email Event details associated with chime.
EmailMailbox: Email Mailbox details associated with chime.
EmailMessage: Email content, safety scan result, and system-generated schema markup for email chimes.
EmailSafetyResult: Result of the email safety scan.
EmailScannedLink: Email Scanned Link details associated with chime.
EmailSchemaMarkup: Schema.org JSON-LD markup generated at email send time.
Page: A page of chime values together with pagination metadata.
Recipient: Recipient information in response.
RecipientEmail: Recipient Email details associated with chime.
RecipientPhone: Recipient Phone details associated with chime.
Transmission: Transmission details associated with chime.
Client: Authenticated entry point for every Inttegro API resource.
CustomData: Merchant-defined string values returned with an Inttegro resource.
CustomDataInput: Merchant-defined JSON values accepted when a resource is created or replaced.
CustomDataPatch: Merchant-defined custom-data changes; a null value removes that key.
CustomDataValue: Immutable base for Inttegro custom-data collections.
Address: Postal address details associated with customer.
AddressInput: Typed postal address accepted by customer create and update requests.
BalanceValue: Balance Value details associated with customer.
CreateRequest: Typed fields for creating a customer.
Customer: A customer record containing contact, balance, address, and lifecycle information.
Page: A page of customer values together with pagination metadata.
UpdateRequest: Typed fields for updating a customer.
DomainValue: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
SDKReportContext: SDK identity included in a privacy-safe terminal failure report.
HTTPReportContext: Privacy-safe HTTP metadata for a failed SDK operation.
APIErrorReportContext: Non-sensitive machine-readable fields from an Inttegro API error.
TraceReportContext: OpenTelemetry identifiers used to correlate a failure with an application-owned trace.
ErrorReport: Privacy-safe description of one terminally failed Inttegro SDK operation.
InttegroError: Base exception for failures raised by the Inttegro SDK.
NetworkError: Failure to reach the Inttegro API or obtain a usable transport response.
TimeoutError: Network failure caused specifically by the configured request timeout.
APIError: Structured non-success response returned by the Inttegro API.
AuthenticationError: API error indicating that the supplied secret key was missing, invalid, or unauthorized.
RateLimitError: API error indicating that the caller exceeded a request rate limit.
Actor: Actor details associated with file.
DeliveryDetails: Purpose-authorized public delivery metadata for browser-rendered assets. Callers should store file IDs as canonical references and treat these URLs as render URLs.
File: Public metadata for a file managed by Inttegro; private storage credentials and object keys are never exposed.
LatestError: Structured failure details reported for file.
Media: Media details associated with file.
Page: A page of file values together with pagination metadata.
Party: Party details associated with file.
PublicStorage: Public Storage details associated with file.
Resource: Resource details associated with file.
Source: Source details associated with file.
UploadReceipt: Upload Receipt details associated with file.
FileDownload: Binary file contents and response headers returned by a download operation.
Access: Access details associated with file link.
Actor: Actor details associated with file link.
Creation: Creation details associated with file link.
Delivery: Delivery details associated with file link.
FileLink: A public file-link record and its access, delivery, and revocation state.
Page: A page of file link values together with pagination metadata.
Reconciliation: Reconciliation details associated with file reference.
FinancialAccount: A verified destination or source account used to push or pull funds.
FinancialInstitution: Financial Institution details associated with financial account.
FinancialInstitutionBank: Financial Institution Bank details associated with financial account.
FinancialInstitutionBankBranch: A bank branch in a country bank directory.
FinancialInstitutionMobileMoneyProvider: Financial Institution Mobile Money Provider details associated with financial account.
Page: A page of financial account values together with pagination metadata.
PullConfiguration: Pull Configuration details associated with financial account.
PullConfigurationMandate: Pull Configuration Mandate details associated with financial account.
PushConfiguration: Push Configuration details associated with financial account.
GenericValue: Immutable value used only where the API contract intentionally permits arbitrary object data.
HttpClient
Telemetry: Emits redacted SDK spans through the application's OpenTelemetry provider.
EmailContent: Email Content details associated with message template.
Mailbox: Mailbox details associated with message template.
MessageTemplate: A reusable SMS or email template, including its variables, content, safety results, and lifecycle state.
Page: A page of message template values together with pagination metadata.
Preview: Preview details associated with message template.
Rendered: Rendered details associated with message template.
RenderedEmail: Rendered Email details associated with message template.
RenderedSMS: Rendered SMS details associated with message template.
SafetyResult: Result of the email safety scan.
ScannedLink: Scanned Link details associated with message template.
SMSContent: SMS Content details associated with message template.
Variable: Variable details associated with message template.
VariableItem: Variable Item details associated with message template.
Amount: A monetary amount returned by Inttegro, pairing an ISO 4217 currency with integer minor units.
AmountParams: A monetary amount supplied in a request, pairing an ISO 4217 currency with integer minor units.
Address: Postal address details associated with order.
CheckoutSettings: Checkout and payment flow configuration. Strongly recommended to provide both redirect_url and cancel_url for a delightful customer experience.
CreatedFrom: Created From details associated with order.
Customer: Customer details associated with order.
DiscountLineItem: Discount Line Item details associated with order.
DiscountLineItemDiscount: Discount Line Item Discount details associated with order.
DocumentDelivery: Delivery result for one hosted order document link.
DocumentDeliveryAttempt: Chime delivery accepted for one channel.
DocumentDeliveryFailure: Chime delivery failure for one channel.
DocumentDeliveryResult: Response returned by deliberate order document delivery endpoints.
DocumentFormat: Document Format details associated with order.
FeeLineItem: Fee Line Item details associated with order.
FeeLineItemFee: Fee Line Item Fee details associated with order.
Invoice: Invoice details associated with order.
InvoiceFormat: Invoice Format details associated with order.
InvoiceSettings: Order-level invoice rendering data. Pages uses this data when rendering invoice web and download views.
LineItemGroup: Group of line items in the order.
Order: A complete commerce order containing line items, customer details, payment state, documents, and fulfillment information.
Page: A page of order values together with pagination metadata.
ProductLineItem: Product Line Item details associated with order.
ProductLineItemProduct: Product Line Item Product details associated with order.
ShippingLineItem: Shipping Line Item details associated with order.
ShippingLineItemShipping: Shipping Line Item Shipping details associated with order.
Transaction: An OTP transaction returned by initiation, verification, and lookup operations.
Transmission: Transmission details associated with otp.
Verification: Verification details associated with otp.
VerificationAttempt: Details of a verification attempt.
VerificationAttemptResult: Verification Attempt Result details associated with otp.
Attempt: Most recent payment attempt details.
AttemptError: Structured failure details reported for payment.
BillingDetails: Billing Details details associated with payment.
Error: Structured failure details reported for payment.
NextAction: Next action required to complete a payment.
NextActionAuthorize: Details for authorization action.
NextActionConfirmPayment: Details for customer payment confirmation.
NextActionConfirmPaymentAttempt: Latest confirmation attempt.
NextActionConfirmPaymentRequest: Next Action Confirm Payment Request details associated with payment.
NextActionRedirect: Details for redirect action.
NextActionRedirectLatestVisit: Latest redirect visit details.
NextActionRequestConfirmation: Details for requesting a fresh customer confirmation.
Payment: A payment intent tied to an order, including its amount, execution state, required action, and settlement details.
PaymentMethod: Payment Method details associated with payment.
PaymentMethodBankAccount: Payment Method Bank Account details associated with payment.
PaymentMethodGhanaBankAccount: Payment Method Ghana Bank Account details associated with payment.
PaymentMethodMobileMoney: Payment Method Mobile Money details associated with payment.
PaymentMethodOwner: Owner identity associated with payment.
PayoutConfiguration: Payout configuration for this balance transaction.
PayoutConfigurationDestination: Where the funds will be paid out.
BankAccount: Bank Account details associated with payment method.
BankAccountGhanaBankAccount: Bank Account Ghana Bank Account details associated with payment method.
Card: Card details associated with payment method.
Deletion: Deletion details associated with payment method.
MobileMoney: Mobile Money details associated with payment method.
Owner: Owner details to patch onto the payment method.
OwnerAddress: Postal address for the owner when available.
Page: A page of payment method values together with pagination metadata.
PaymentMethod: A tokenized payment instrument tied to a customer, with typed instrument and verification details.
Settings: Payment method acceptance configuration for an application.
Supplied: Public provenance for how the payment method was supplied.
TypeSetting: Settings for a specific payment method type.
Verification: Most recent verification record when the payment method has entered a verification flow.
VerificationDelivery: Verification Delivery details associated with payment method.
VerificationSession: A payment-method verification session, including token delivery and expiry state.
BalanceTransaction: A sparse view of one balance transaction's contribution to a payout.
Destinations: Supported currency-to-financial-account payout assignments.
Error: Public failure details when execution fails.
Failure: Caller-safe information about a terminal payout failure.
Page: A page of payout values together with pagination metadata.
PageRequest: Pagination parameters for retrieving payout history.
Payout: A transfer scheduled from an Inttegro balance to a destination financial account.
ScheduleRequest: Parameters for scheduling a payout to a financial account.
SettingsLookup: Complete payout settings read model.
SettingsLookupSchedule: Active payout schedule.
SettingsLookupScheduleAgingSpec: Settings Lookup Schedule Aging Spec details associated with payout.
SettingsMutation: Payout settings fields returned after a mutation.
SettingsMutationSchedule: Updated payout schedule.
SettingsMutationScheduleSpec: Settings Mutation Schedule Spec details associated with payout.
CustomerSelectedAmount: Persisted currency, range, and suggestions for a selected amount.
CustomerSelectedAmountParams: Currency, range, and optional conveniences for a selected amount.
EmbeddedProduct: Embedded Product details associated with price.
EmbeddedProductAttributesItem: Embedded Product Attributes Item details associated with price.
Inline: An inline amount returned where the API embeds a one-off price rather than a catalog price.
InlineParams: A typed inline price supplied directly inside another request.
Page: A page of price values together with pagination metadata.
Params: Typed parameters for creating a reusable catalog price.
Price: A reusable catalog price that can be attached to products and order line items.
SuggestedAmount: A convenient amount choice returned with a catalog price.
SuggestedAmountParams: A convenient amount choice; suggestions do not restrict valid amounts.
AddPriceRequest: Typed parameters for adding one price to an existing product.
Attribute: Attribute details associated with product.
CatalogWithCustomerSelectedPrice: Catalog product using an amount selected under one saved price policy.
CustomerSelectedPriceInput: Couples a saved customer-selected price with one concrete unit amount.
Delivery: Delivery details associated with product.
Dimensions: At most one of `physical`, `digital`, or `custom`.
DimensionsCustom: Dimensions Custom details associated with product.
DimensionsDigital: Dimensions Digital details associated with product.
DimensionsPhysical: Dimensions Physical details associated with product.
Download: Download details associated with product.
Media: Media details associated with product.
Page: A page of product values together with pagination metadata.
PriceSummary: Price Summary details associated with product.
Product: A catalog product, including merchandising details, prices, media, delivery configuration, and lifecycle state.
Render: Render details associated with product.
Service: Service details associated with product.
Shipment: Shipment details associated with product.
Stream: Stream details associated with product.
Updated: Updated details associated with product.
BuyPagePresentation: Presentation settings for the hosted Buy page.
BuyPageText: Merchant-authored copy shown on a hosted Buy page.
Merchant: Merchant identity captured for the hosted checkout. Individual fields are omitted when unavailable.
OriginalPrice: Original Price details associated with purchase intent.
Page: A page of purchase intent values together with pagination metadata.
Presentation: Customer-facing presentation settings for a purchase intent.
Price: Price details associated with purchase intent.
Product: Product details associated with purchase intent.
ProductAttributesItem: Product Attributes Item details associated with purchase intent.
PurchaseIntent: A shareable purchase intent that captures product, price, quantity, variants, and usage.
Quantity: Quantity bounds the Buy link should enforce. Omit max when the Buy link has no upper quantity bound. When present, max must be greater than or equal to min.
Usage: Exactly one of multi_use or single_use is returned as true. Order is present after a single-use intent is consumed.
UsageOrder: Usage Order details associated with purchase intent.
Variant: Variant details associated with purchase intent.
VariantAxis: Variant Axis details associated with purchase intent.
VariantSet: Variant Set details associated with purchase intent.
Failure: Sanitized terminal refund failure information.
FeeOrderLineItem: Immutable fee order-line snapshot attached to a refund.
LineItem: Line Item details associated with refund.
OfflineSettlement: Refund settlement for an order paid outside Inttegro.
OrderLineItemAdjustment: Descriptive fields captured for a refund fee or shipping line.
OrderLineItemProduct: Product identity captured in a refund order-line snapshot.
Page: A page of refund values together with pagination metadata.
PaymentMethodSettlement: Refund settlement returned to the original payment method.
ProductOrderLineItem: Immutable product order-line snapshot attached to a refund.
Refund: A refund request and its amount, reason, affected line items, lifecycle state, and related balance transaction.
SettlementBankAccount: Supported bank-account subtype and its masked details.
SettlementBankAccountPaymentMethod: Caller-safe bank-account snapshot used as a refund destination.
SettlementGhanaBankAccount: Masked Ghana bank-account recognition details.
SettlementMobileMoney: Masked mobile-money recognition details.
SettlementMobileMoneyPaymentMethod: Caller-safe mobile-money snapshot used as a refund destination.
ShippingOrderLineItem: Immutable shipping order-line snapshot attached to a refund.
Apps: Application creation, lookup, and update operations.
Balances: Client operations for Inttegro balances.
BalanceTransactions: Balance transactions resource for payment- and refund-sourced merchant balance entries.
Broadcasts: * Broadcasts resource for looking up and canceling broadcasts.
Chimes: Chimes resource for sending notifications via SMS and email.
Customers: * Customers resource for managing customer records.
FileLinks: Client operations for Inttegro file links.
FileReferences: Client operations for Inttegro file references.
Files: Client operations for Inttegro files.
FinancialAccounts: Financial accounts resource for managing payout destinations.
Keys: Client operations for Inttegro keys.
MessageTemplates: Client operations for Inttegro message templates.
Orders: Orders resource for creating orders, processing payments, and managing order lifecycle.
Otp: OTP resource for managing one-time password sessions.
PaymentMethods: Payment methods resource for saving and verifying customer payment instruments.
Payouts: Payouts resource for managing automatic settlements and balance withdrawals.
Prices: * Prices resource for managing catalog prices.
Products: * Products resource for managing catalog products.
PurchaseIntents: Client operations for Inttegro purchase intents.
Refunds: Refunds resource for managing order refunds.
Schedules: * Schedules resource for looking up and canceling scheduled chimes.
Spec: Spec resource for retrieving Inttegro platform specifications.
UploadRequests: Client operations for Inttegro upload requests.
Response: Decoded SDK value plus response-only HTTP metadata.
CancelDetail: Cancel Detail details associated with schedule.
CreationDetail: Creation Detail details associated with schedule.
Error: Error encountered when scheduling a chime for a specific recipient.
Schedule: A scheduled operation and its timing, creation, cancellation, and failure state.
ResourceSearchFilter: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchFacet: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchSort: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchRequest: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchTotal: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchResourceTotal: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchResourceReference: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchResult: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchFacetBucket: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchFacetResult: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchResourceFreshness: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchFreshness: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
ResourceSearchPage: Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.
Generated: Newly generated secret key. The token is returned once and cannot be retrieved later.
Page: A page of secret key values together with pagination metadata.
SecretKey: Metadata for an application secret key; the secret token itself is returned only when a key is generated.
Usage: Usage details associated with secret key.
UsagePage: A page of secret key values together with pagination metadata.
UsageRow: Public authentication outcome associated with the selected key.
CountryBank: A banking institution available in a country.
CountryBankBranch: A bank branch in a country bank directory.
CountryBankDirectory: Bank reference data available for country-specific bank accounts.
CountrySpecification: Complete specification for a country including supported features and requirements.
CountrySpecifications: Country Specifications details associated with shared.
Error: Standard error response structure returned by all API endpoints. Provides machine-readable codes, human-readable messages, and actionable guidance for resolution.
ResourceSupply: Resource Supply details associated with shared.
UploadFulfillment: Upload Fulfillment details associated with shared.
Actor: Actor details associated with upload request.
Attempt: Attempt details associated with upload request.
Attempts: Attempts details associated with upload request.
Constraints: Constraints details associated with upload request.
Display: Display details associated with upload request.
LatestError: Structured failure details reported for upload request.
Page: A page of upload request values together with pagination metadata.
Review: Review details associated with upload request.
ReviewReason: Review Reason details associated with upload request.
UploadRequest: A public upload request, including its constraints, attempts, review state, and expiration.
Version: Installed Inttegro PHP SDK version metadata.
MobileMoney: Mobile Money details associated with wallet.
Wallet: Wallet details associated with a payment method or financial account.

Enums

CredentialOwner: Who can create, rotate, or disable the child app's API keys after creation. Defaults to child. In V1, apps/create still returns the initial child key to the caller.
ManagementRole: Who can manage the child app and its resources through this relationship.
RelationshipKind: Allowed wire values for app relationship kind.
RelationshipStatus: Allowed wire values for app relationship status.
Type: Semantic source or cause of this entry, not its direction.
Type: Allowed wire values for bank account type.
OrderStatus: Current status of the order.
PaymentStatus: Payment status.
EmailSchemaKind: Classification for the generated markup.
RecipientType: Contact type.
Transport: Allowed wire values for chime transport.
Delivery: Allowed wire values for file delivery.
Disposition: Allowed wire values for file disposition.
ScanStatus: Allowed wire values for file scan status.
SourceType: Allowed wire values for file source type.
Status: Allowed wire values for file status.
StorageEncoding: Encoding of the stored representation.
DeliveryMode: Allowed wire values for file link delivery mode.
Kind: Allowed wire values for file link kind.
Status: Allowed wire values for file link status.
Type: Type of financial account.
Channel: Delivery channel this template renders for.
Status: Allowed wire values for message template status.
VariableItemType: Allowed wire values for message template variable item type.
VariableType: Allowed wire values for message template variable type.
Currency: A currency code recognized by the Inttegro API. Individual operations can support a subset of these currencies.
CreatedFromResourceType: Allowed wire values for order created from resource type.
DeliveryChannel: Delivery channel.
DocumentKind: Hosted document that was delivered.
LineItemType: Type of line item.
Status: Allowed wire values for order status.
AlphabetType: Predefined alphabet type (mutually exclusive with token_alphabet).
Purpose: Customer action protected by an OTP.
Status: Allowed wire values for otp status.
TransmissionStatus: Allowed wire values for otp transmission status.
VerificationVerdict: Allowed wire values for otp verification verdict.
AttemptStatus: Allowed wire values for payment attempt status.
ConfirmationChannel: Channel used to send the token.
NextActionType: Type of action required.
ResultStatus: Payment status.
Status: Payment state.
MobileMoneyNetwork: Allowed wire values for payment method mobile money network.
Type: Allowed wire values for payment method type.
FailureReason: Stable, caller-safe reasons that a payout failed.
Status: Current payout lifecycle state.
Type: Definition carried by a catalog price.
ShipmentInputType: Allowed wire values for product shipment input type.
ShipmentType: Allowed wire values for product shipment type.
Type: Product type - determines fulfillment requirements.
Status: Effective lifecycle state derived from expiry, cancellation, and single-use order creation.
FailureReason: Stable, caller-safe reasons that terminal refund processing failed.
Reason: Allowed wire values for refund reason.
Status: Allowed wire values for refund status.
ResourceSearchOperator
ResourceSearchSortField
ResourceSearchSortDirection
ResourceSearchResourceType
ResourceSearchTotalRelation
ResourceSearchFreshnessState
AuthResult: Allowed wire values for secret key auth result.
Status: Allowed wire values for secret key status.
TokenType: Allowed wire values for secret key token type.
ContentSafetyStatus: Allowed wire values for shared content safety status.
ReviewDecision: Allowed wire values for upload request review decision.
ReviewType: Allowed wire values for upload request review type.
Status: Allowed wire values for upload request status.
Type: Allowed wire values for wallet type.

Inttegro PHP SDK

Application

Table of Contents

Classes

Enums

Search results