@timbro/invoices 0.10.3 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +58 -2
- package/dist/admin.d.ts +2 -3
- package/dist/admin.d.ts.map +1 -1
- package/dist/generated/hosted/index.d.ts +3 -3
- package/dist/generated/hosted/index.d.ts.map +1 -1
- package/dist/generated/hosted/index.js +2 -2
- package/dist/generated/hosted/sdk.gen.d.ts +19 -1
- package/dist/generated/hosted/sdk.gen.d.ts.map +1 -1
- package/dist/generated/hosted/sdk.gen.js +225 -1
- package/dist/generated/hosted/types.gen.d.ts +583 -5
- package/dist/generated/hosted/types.gen.d.ts.map +1 -1
- package/dist/generated/hosted/zod-response.gen.d.ts +6678 -208
- package/dist/generated/hosted/zod-response.gen.d.ts.map +1 -1
- package/dist/generated/hosted/zod-response.gen.js +694 -207
- package/dist/generated/hosted/zod.gen.d.ts +1661 -14
- package/dist/generated/hosted/zod.gen.d.ts.map +1 -1
- package/dist/generated/hosted/zod.gen.js +772 -222
- package/dist/generated/index.d.ts +3 -3
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/index.js +2 -2
- package/dist/generated/invoice-api-contract.d.ts +186 -2
- package/dist/generated/invoice-api-contract.d.ts.map +1 -1
- package/dist/generated/invoice-api-contract.js +211 -1
- package/dist/generated/sdk.gen.d.ts +5 -5
- package/dist/generated/sdk.gen.d.ts.map +1 -1
- package/dist/generated/sdk.gen.js +93 -93
- package/dist/generated/types.gen.d.ts +288 -139
- package/dist/generated/types.gen.d.ts.map +1 -1
- package/dist/generated/zod-response.gen.d.ts +2304 -2548
- package/dist/generated/zod-response.gen.d.ts.map +1 -1
- package/dist/generated/zod-response.gen.js +179 -109
- package/dist/generated/zod.gen.d.ts +1252 -2188
- package/dist/generated/zod.gen.d.ts.map +1 -1
- package/dist/generated/zod.gen.js +215 -115
- package/dist/hosted-tenant.d.ts +9 -0
- package/dist/hosted-tenant.d.ts.map +1 -1
- package/dist/hosted-tenant.js +7 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/invoice-hosted-controls.d.ts +22 -3
- package/dist/invoice-hosted-controls.d.ts.map +1 -1
- package/dist/invoice-hosted-controls.js +48 -12
- package/dist/invoice.d.ts +5 -0
- package/dist/invoice.d.ts.map +1 -1
- package/dist/invoice.js +1 -0
- package/dist/issuance-readiness.d.ts +9 -0
- package/dist/issuance-readiness.d.ts.map +1 -0
- package/dist/issuance-readiness.js +19 -0
- package/dist/timbro-client.d.ts +6 -8
- package/dist/timbro-client.d.ts.map +1 -1
- package/dist/timbro-client.js +3 -5
- package/dist/webhook-event.d.ts +392 -0
- package/dist/webhook-event.d.ts.map +1 -1
- package/package.json +3 -3
- package/dist/certificate-custody-readiness.d.ts +0 -6
- package/dist/certificate-custody-readiness.d.ts.map +0 -1
- package/dist/certificate-custody-readiness.js +0 -13
- package/dist/fiscal-numbering-readiness.d.ts +0 -6
- package/dist/fiscal-numbering-readiness.d.ts.map +0 -1
- package/dist/fiscal-numbering-readiness.js +0 -13
|
@@ -48,6 +48,10 @@ export type MerchantBusinessFiscalSetupAvailable = {
|
|
|
48
48
|
id: string;
|
|
49
49
|
documentType: "31" | "32" | "33" | "34" | "41" | "43" | "44" | "45" | "46" | "47";
|
|
50
50
|
};
|
|
51
|
+
/**
|
|
52
|
+
* Whether each e-CF type can be issued now in this environment, in type order, as Timbro reports it. Empty while the environment has no connected hosted binding; once bound, Timbro lists every e-CF type. `null` when Timbro's readiness could not be read; read the business again.
|
|
53
|
+
*/
|
|
54
|
+
documentTypes: Array<DocumentTypeIssuanceReadiness> | null;
|
|
51
55
|
};
|
|
52
56
|
/**
|
|
53
57
|
* MerchantBusinessFiscalBinding
|
|
@@ -92,6 +96,36 @@ export type MerchantBusinessSigningCertificate = {
|
|
|
92
96
|
notBefore: string;
|
|
93
97
|
notAfter: string;
|
|
94
98
|
};
|
|
99
|
+
/**
|
|
100
|
+
* DocumentTypeIssuanceReadiness
|
|
101
|
+
*
|
|
102
|
+
* Whether Timbro can issue one e-CF type now, as Timbro reports it.
|
|
103
|
+
*/
|
|
104
|
+
export type DocumentTypeIssuanceReadiness = {
|
|
105
|
+
type: "E31" | "E32" | "E33" | "E34" | "E41" | "E43" | "E44" | "E45" | "E46" | "E47";
|
|
106
|
+
status: "ready";
|
|
107
|
+
numbering: NumberingRange;
|
|
108
|
+
} | {
|
|
109
|
+
type: "E31" | "E32" | "E33" | "E34" | "E41" | "E43" | "E44" | "E45" | "E46" | "E47";
|
|
110
|
+
status: "actionRequired";
|
|
111
|
+
/**
|
|
112
|
+
* Every condition that blocks this type: issuer, then certificate, then numbering.
|
|
113
|
+
*/
|
|
114
|
+
reasons: Array<"legal_issuer_profile_incomplete" | "signing_certificate_missing" | "signing_certificate_expired" | "signing_certificate_not_yet_valid" | "authorization_missing" | "authorization_not_active" | "authorization_not_verified" | "authorization_not_observed" | "range_exhausted" | "authorization_expiration_invalid" | "authorization_expired" | "authorization_range_overlap">;
|
|
115
|
+
numbering: NumberingRange | null;
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* NumberingRange
|
|
119
|
+
*
|
|
120
|
+
* The range Timbro assigns the next fiscal number of this type from.
|
|
121
|
+
*/
|
|
122
|
+
export type NumberingRange = {
|
|
123
|
+
/**
|
|
124
|
+
* Fiscal numbers left in the selected range.
|
|
125
|
+
*/
|
|
126
|
+
remaining: number;
|
|
127
|
+
expiresOn: string | null;
|
|
128
|
+
};
|
|
95
129
|
/**
|
|
96
130
|
* MerchantBusinessLiveFiscalSetup
|
|
97
131
|
*
|
|
@@ -106,6 +140,10 @@ export type MerchantBusinessLiveFiscalSetupAvailable = {
|
|
|
106
140
|
binding: MerchantBusinessFiscalBinding;
|
|
107
141
|
legalIssuer: MerchantBusinessLegalIssuer;
|
|
108
142
|
signingCertificate: MerchantBusinessSigningCertificate;
|
|
143
|
+
/**
|
|
144
|
+
* Whether each e-CF type can be issued now in this environment, in type order, as Timbro reports it. Empty while the environment has no connected hosted binding; once bound, Timbro lists every e-CF type. `null` when Timbro's readiness could not be read; read the business again.
|
|
145
|
+
*/
|
|
146
|
+
documentTypes: Array<DocumentTypeIssuanceReadiness> | null;
|
|
109
147
|
};
|
|
110
148
|
/**
|
|
111
149
|
* Problem
|
|
@@ -116,7 +154,7 @@ export type Problem = {
|
|
|
116
154
|
/**
|
|
117
155
|
* Stable machine-readable code. Branch on this, never on `title`.
|
|
118
156
|
*/
|
|
119
|
-
code: "merchant_authentication_unavailable" | "platform_test_profile_unavailable" | "merchant_fiscal_binding_unavailable" | "merchant_fiscal_setup_unavailable" | "merchant_contact_email_confirmation_required" | "merchant_service_scope_required" | "merchant_business_address_required" | "merchant_business_contact_required" | "merchant_business_location_official_codes_required" | "merchant_business_details_invalid" | "merchant_current_payment_methods_required" | "merchant_current_sales_channels_required" | "merchant_existing_card_service_not_applicable" | "merchant_existing_card_service_other_provider_name_invalid" | "merchant_existing_card_service_other_provider_name_not_allowed" | "merchant_existing_card_service_other_provider_name_required" | "merchant_existing_card_service_providers_exclusive_choice" | "merchant_existing_card_service_providers_required" | "merchant_existing_card_service_required" | "merchant_location_catalog_changed" | "merchant_location_catalog_unavailable" | "merchant_location_selection_invalid" | "merchant_payment_methods_not_applicable" | "merchant_sales_channels_exclusive_choice" | "merchant_sales_channels_not_applicable" | "merchant_business_type_not_applicable" | "merchant_charge_timing_not_applicable" | "merchant_charge_timing_required" | "merchant_payment_methods_exclusive_choice" | "merchant_session_missing" | "merchant_guest_notice_acceptance_required" | "merchant_workspace_organization_required" | "merchant_onboarding_revision_conflict" | "merchant_checkout_policy_revision_conflict" | "merchant_business_already_claimed" | "merchant_business_attachment_conflict" | "merchant_business_identity_required" | "merchant_business_not_member" | "merchant_business_revision_conflict" | "merchant_business_capabilities_required" | "merchant_fiscal_setup_incomplete" | "merchant_payment_setup_assessment_incomplete" | "merchant_certificate_conflict" | "merchant_test_fiscal_document_blocked" | "merchant_dgii_assistance_not_applicable" | "merchant_dgii_assistance_notes_invalid" | "parameter_missing" | "parameter_invalid" | "provider_not_available" | "currency_not_supported" | "amount_below_minimum" | "amount_above_maximum" | "checkout_reference_invalid" | "checkout_reference_expired" | "fiscal_buyer_tax_id_invalid" | "fiscal_lines_required" | "payment_split_invalid" | "submission_token_invalid" | "submission_token_expired" | "request_body_malformed" | "collection_cursor_invalid" | "webhook_replay_scope_invalid" | "api_key_missing" | "api_key_invalid" | "checkout_token_invalid" | "checkout_token_expired" | "payer_session_missing" | "operation_not_permitted" | "invoice_delivery_not_permitted" | "journey_scope_mismatch" | "journey_report_timeout" | "merchant_fiscal_binding_conflict" | "live_mode_not_enabled" | "origin_not_allowed" | "payer_step_up_required" | "certificate_handoff_person_mismatch" | "route_not_found" | "api_key_not_found" | "payment_not_found" | "payment_reference_conflict" | "refund_reference_conflict" | "payment_reference_invalid" | "refund_reference_invalid" | "payment_tax_required" | "payment_tax_invalid" | "payment_items_invalid" | "payment_totals_mismatch" | "payment_invoice_item_fields_required" | "payments_contract_migration_required" | "merchant_payments_api_paused" | "refund_not_found" | "refund_invoice_not_ready" | "refund_invoice_not_accepted" | "refund_invoice_mismatch" | "refund_invoice_conflict" | "payment_part_not_found" | "payment_split_not_found" | "fiscal_document_not_found" | "merchant_account_not_found" | "merchant_account_card_capability_not_found" | "merchant_business_not_found" | "agent_client_not_found" | "connected_agent_not_found" | "certificate_handoff_not_found" | "webhook_endpoint_not_found" | "webhook_event_not_found" | "three_ds_not_found" | "payer_not_found" | "saved_card_not_found" | "payer_credential_not_found" | "payer_purchase_not_found" | "payer_fiscal_profile_not_found" | "idempotency_key_reused" | "idempotency_request_in_progress" | "idempotency_key_expired" | "api_key_retired" | "payment_method_already_in_progress" | "payment_not_payable" | "refund_not_allowed" | "refund_already_exists" | "payment_awaiting_verification" | "payment_attempt_invalid" | "payment_attempt_mismatch" | "payment_attempt_stale" | "payment_method_mismatch" | "provider_response_invalid" | "decline_not_retryable" | "checkout_window_closed" | "payment_not_editable" | "payment_cancel_not_allowed" | "payment_cancellation_pending" | "invoicing_locked" | "source_identity_conflict" | "refund_source_identity_conflict" | "refund_payment_not_captured" | "refund_exceeds_captured" | "refund_allocation_not_found" | "refund_allocation_conflict" | "refund_allocation_ledger_unavailable" | "fiscal_buyer_required" | "fiscal_artifact_not_ready" | "payment_invoice_not_ready" | "payment_invoice_not_allowed" | "invoice_reference_stale" | "fiscal_delivery_not_ready" | "payment_split_not_allowed" | "payment_split_exists" | "payment_split_locked" | "payment_split_not_capturable" | "payment_split_not_expired" | "payment_split_not_renewable" | "payment_split_complete" | "payment_split_part_required" | "payment_part_not_payable" | "webhook_endpoint_deleted" | "webhook_endpoint_suspended" | "three_ds_binding_mismatch" | "payer_enrollment_unavailable" | "payer_claim_unavailable" | "payer_claim_conflict" | "payer_claim_proof_invalid" | "payer_delivery_address_unavailable" | "payer_fiscal_profile_unavailable" | "certificate_handoff_used" | "receipt_retention_elapsed" | "certificate_handoff_expired" | "request_body_too_large" | "unsupported_media_type" | "merchant_account_not_ready" | "merchant_checkout_policy_invalid" | "merchant_account_provider_mismatch" | "merchant_account_identity_mismatch" | "merchant_profile_incomplete" | "payment_description_required" | "sale_amount_invalid" | "credential_storage_unavailable" | "refund_credentials_unavailable" | "refund_provider_unavailable" | "refund_provider_reference_unavailable" | "provider_not_eligible" | "no_eligible_provider" | "currency_not_supported_by_provider" | "currency_not_supported_for_fiscal_document" | "fiscal_total_mismatch" | "fiscal_line_total_invalid" | "fiscal_line_legal_tip_invalid" | "fiscal_document_kind_not_allowed" | "fiscal_document_kind_unsupported" | "fiscal_government_eligibility_required" | "fiscal_government_eligibility_not_allowed" | "certificate_p12_password_invalid" | "certificate_pkcs12_invalid" | "certificate_expired" | "certificate_not_yet_valid" | "certificate_archive_not_supported" | "certificate_not_supported" | "taxpayer_unregistered" | "taxpayer_inactive" | "voluntary_tip_currency_mismatch" | "voluntary_tip_not_allowed_for_split" | "voluntary_tip_not_available" | "voluntary_tip_exceeds_maximum" | "refund_tip_amount_invalid" | "refund_tip_allocation_unknown" | "refund_amount_invalid" | "refund_currency_mismatch" | "payer_fiscal_profile_invalid" | "rate_limit_exceeded" | "internal_error" | "provider_unavailable" | "provider_rejected_request" | "taxpayer_directory_unavailable" | "fiscal_artifact_retrieval_unavailable" | "fiscal_delivery_unavailable" | "journey_marks_unavailable" | "contact_request_delivery_unavailable" | "unauthenticated" | "invalid_login" | "email_already_registered" | "organization_slug_taken" | "organization_not_found" | "hosted_tenant_conflict" | "insufficient_role" | "service_role_not_permitted" | "invalid_fiscal_identity" | "invalid_certificate_custody_signer_identity" | "custody_certificate_malformed" | "custody_certificate_not_yet_valid" | "custody_certificate_expired" | "custody_p12_work_limit_exceeded" | "custody_signature_algorithm_unsupported" | "custody_certificate_trust_profile_unsupported" | "custody_certificate_chain_untrusted" | "custody_certificate_purpose_unsupported" | "legal_issuer_already_registered" | "onboarding_legal_issuer_identity_conflict" | "legal_issuer_profile_incomplete" | "legal_issuer_not_found" | "invitation_invalid" | "invitation_expired" | "already_a_member" | "environment_not_active" | "certificate_custody_binding_not_found" | "certificate_custody_binding_conflict" | "certificate_custody_certificate_version_not_active" | "source_connection_not_found" | "source_connection_not_connected" | "source_provider_unavailable" | "source_provider_authorization_required" | "source_provider_installation_disabled" | "source_provider_installation_removed" | "source_provider_scope_insufficient" | "source_provider_target_access_removed" | "source_provider_throttled" | "source_provider_outcome_unknown" | "source_provider_authorization_not_found" | "source_provider_authorization_conflict" | "source_provider_installation_request_invalid" | "source_provider_installation_request_expired" | "source_provider_installation_callback_replayed" | "source_connection_creation_conflict" | "source_connection_activation_conflict" | "source_connection_activation_verification_rejected" | "delegated_authorization_verifier_forbidden" | "invalid_credential" | "credential_revoked" | "issuer_not_authorized" | "missing_idempotency_key" | "invalid_idempotency_key" | "request_too_large" | "request_body_timeout" | "malformed_json" | "invalid_request" | "invalid_collection_query" | "invalid_collection_cursor" | "document_type_not_enabled" | "fiscal_intent_rejected" | "idempotency_key_conflict" | "fiscal_number_already_used" | "fiscal_number_authorization_changed" | "fiscal_number_authorization_source_record_conflict" | "source_version_stale" | "source_predecessor_conflict" | "source_history_requires_reconciliation" | "source_content_conflict" | "source_action_conflict" | "source_command_conflict" | "invoice_reference_conflict" | "invoice_totals_mismatch" | "printed_representation_profile_conflict" | "source_record_already_fiscalized" | "source_operation_pending" | "source_outcome_unknown" | "authority_rejected_replacement" | "correction_target_unsettled" | "unsupported_printed_representation_profile" | "affected_fiscal_operation_unsupported" | "fiscal_issuance_blocked" | "fiscal_operation_not_found" | "invoice_not_found" | "fiscal_artifact_not_found" | "fiscal_artifact_unverified" | "fiscal_artifact_unavailable" | "invoice_receipt_not_found" | "invoice_receipt_not_ready" | "invoice_receipt_unavailable" | "fiscal_delivery_not_found" | "fiscal_delivery_outcome_conflict" | "webhook_endpoint_registration_conflict" | "invalid_replay_scope" | "webhook_destination_not_allowed" | "unsigned_document_schema_invalid" | "signed_document_schema_invalid" | "custody_unavailable" | "received_document_not_found" | "commercial_response_motive_invalid" | "commercial_response_decision_conflict" | "method_not_allowed";
|
|
157
|
+
code: "authorization_not_found" | "authorization_checkout_reference_invalid" | "authorization_reference_conflict" | "authorization_capture_conflict" | "authorization_capture_exceeds_hold" | "authorization_not_capturable" | "authorization_not_cancelable" | "authorization_not_editable" | "authorization_submission_invalid" | "authorization_authentication_pending" | "authorization_credentials_unavailable" | "authorization_dispatch_refused" | "authorization_hold_evidence_missing" | "provider_qualification_required" | "merchant_authentication_unavailable" | "platform_test_profile_unavailable" | "merchant_fiscal_binding_unavailable" | "merchant_fiscal_setup_unavailable" | "merchant_contact_email_confirmation_required" | "merchant_service_scope_required" | "merchant_business_address_required" | "merchant_business_contact_required" | "merchant_business_location_official_codes_required" | "merchant_business_details_invalid" | "merchant_current_payment_methods_required" | "merchant_current_sales_channels_required" | "merchant_existing_card_service_not_applicable" | "merchant_existing_card_service_other_provider_name_invalid" | "merchant_existing_card_service_other_provider_name_not_allowed" | "merchant_existing_card_service_other_provider_name_required" | "merchant_existing_card_service_providers_exclusive_choice" | "merchant_existing_card_service_providers_required" | "merchant_existing_card_service_required" | "merchant_location_catalog_changed" | "merchant_location_catalog_unavailable" | "merchant_location_selection_invalid" | "merchant_payment_methods_not_applicable" | "merchant_sales_channels_exclusive_choice" | "merchant_sales_channels_not_applicable" | "merchant_business_type_not_applicable" | "merchant_charge_timing_not_applicable" | "merchant_charge_timing_required" | "merchant_payment_methods_exclusive_choice" | "merchant_session_missing" | "merchant_guest_notice_acceptance_required" | "merchant_workspace_organization_required" | "merchant_onboarding_revision_conflict" | "merchant_checkout_policy_revision_conflict" | "merchant_business_already_claimed" | "merchant_business_attachment_conflict" | "merchant_business_identity_required" | "merchant_business_not_member" | "merchant_business_revision_conflict" | "merchant_business_capabilities_required" | "merchant_business_certification_path_unavailable" | "merchant_business_certification_requirements_unmet" | "merchant_business_certification_revision_conflict" | "merchant_business_certification_evidence_not_found" | "merchant_fiscal_setup_incomplete" | "merchant_payment_setup_assessment_incomplete" | "merchant_certificate_conflict" | "merchant_test_fiscal_document_blocked" | "merchant_dgii_assistance_not_applicable" | "merchant_dgii_assistance_notes_invalid" | "parameter_missing" | "parameter_invalid" | "provider_not_available" | "currency_not_supported" | "amount_below_minimum" | "amount_above_maximum" | "checkout_reference_invalid" | "checkout_reference_expired" | "fiscal_buyer_tax_id_invalid" | "fiscal_lines_required" | "payment_split_invalid" | "submission_token_invalid" | "submission_token_expired" | "request_body_malformed" | "collection_cursor_invalid" | "webhook_replay_scope_invalid" | "api_key_missing" | "api_key_invalid" | "checkout_token_invalid" | "checkout_token_expired" | "payer_session_missing" | "operation_not_permitted" | "invoice_delivery_not_permitted" | "journey_scope_mismatch" | "journey_report_timeout" | "merchant_fiscal_binding_conflict" | "live_mode_not_enabled" | "origin_not_allowed" | "payer_step_up_required" | "certificate_handoff_person_mismatch" | "route_not_found" | "api_key_not_found" | "payment_not_found" | "payment_reference_conflict" | "refund_reference_conflict" | "payment_reference_invalid" | "refund_reference_invalid" | "payment_tax_required" | "payment_tax_invalid" | "payment_items_invalid" | "payment_totals_mismatch" | "payment_invoice_item_fields_required" | "payments_contract_migration_required" | "merchant_payments_api_paused" | "refund_not_found" | "refund_invoice_not_ready" | "refund_invoice_not_accepted" | "refund_invoice_mismatch" | "refund_invoice_conflict" | "payment_part_not_found" | "payment_split_not_found" | "fiscal_document_not_found" | "merchant_account_not_found" | "merchant_account_card_capability_not_found" | "merchant_business_not_found" | "agent_client_not_found" | "connected_agent_not_found" | "certificate_handoff_not_found" | "webhook_endpoint_not_found" | "webhook_event_not_found" | "three_ds_not_found" | "payer_not_found" | "saved_card_not_found" | "payer_credential_not_found" | "payer_purchase_not_found" | "payer_fiscal_profile_not_found" | "idempotency_key_reused" | "idempotency_request_in_progress" | "idempotency_key_expired" | "api_key_retired" | "payment_method_already_in_progress" | "payment_not_payable" | "payment_awaiting_verification" | "payment_attempt_invalid" | "payment_attempt_mismatch" | "payment_attempt_stale" | "payment_method_mismatch" | "provider_response_invalid" | "checkout_window_closed" | "payment_not_editable" | "payment_cancel_not_allowed" | "payment_cancellation_pending" | "invoicing_locked" | "source_identity_conflict" | "refund_source_identity_conflict" | "refund_payment_not_captured" | "refund_exceeds_captured" | "refund_allocation_not_found" | "refund_allocation_conflict" | "refund_allocation_ledger_unavailable" | "fiscal_buyer_required" | "fiscal_artifact_not_ready" | "payment_invoice_not_ready" | "payment_invoice_not_allowed" | "invoice_reference_stale" | "fiscal_delivery_not_ready" | "payment_split_not_allowed" | "payment_split_exists" | "payment_split_locked" | "payment_split_not_capturable" | "payment_split_not_expired" | "payment_split_not_renewable" | "payment_split_complete" | "payment_split_part_required" | "payment_part_not_payable" | "webhook_endpoint_deleted" | "webhook_endpoint_suspended" | "three_ds_binding_mismatch" | "payer_enrollment_unavailable" | "payer_claim_unavailable" | "payer_claim_conflict" | "payer_claim_proof_invalid" | "payer_delivery_address_unavailable" | "payer_fiscal_profile_unavailable" | "certificate_handoff_used" | "receipt_retention_elapsed" | "certificate_handoff_expired" | "request_body_too_large" | "unsupported_media_type" | "merchant_account_not_ready" | "merchant_checkout_policy_invalid" | "merchant_account_provider_mismatch" | "merchant_account_identity_mismatch" | "merchant_profile_incomplete" | "payment_description_required" | "sale_amount_invalid" | "credential_storage_unavailable" | "provider_not_eligible" | "no_eligible_provider" | "currency_not_supported_by_provider" | "currency_not_supported_for_fiscal_document" | "fiscal_total_mismatch" | "fiscal_line_total_invalid" | "fiscal_line_legal_tip_invalid" | "fiscal_document_kind_not_allowed" | "fiscal_document_kind_unsupported" | "fiscal_government_eligibility_required" | "fiscal_government_eligibility_not_allowed" | "certificate_p12_password_invalid" | "certificate_pkcs12_invalid" | "certificate_expired" | "certificate_not_yet_valid" | "certificate_archive_not_supported" | "certificate_not_supported" | "taxpayer_unregistered" | "taxpayer_inactive" | "voluntary_tip_currency_mismatch" | "voluntary_tip_not_allowed_for_split" | "voluntary_tip_not_available" | "voluntary_tip_exceeds_maximum" | "refund_tip_amount_invalid" | "refund_tip_allocation_unknown" | "refund_amount_invalid" | "refund_tax_amount_invalid" | "refund_tax_amount_required" | "refund_tax_allocation_unknown" | "refund_currency_mismatch" | "payer_fiscal_profile_invalid" | "rate_limit_exceeded" | "internal_error" | "provider_unavailable" | "provider_rejected_request" | "taxpayer_directory_unavailable" | "fiscal_artifact_retrieval_unavailable" | "fiscal_delivery_unavailable" | "journey_marks_unavailable" | "contact_request_delivery_unavailable" | "unauthenticated" | "invalid_login" | "email_already_registered" | "organization_slug_taken" | "organization_not_found" | "hosted_tenant_conflict" | "insufficient_role" | "service_role_not_permitted" | "invalid_fiscal_identity" | "invalid_certificate_custody_signer_identity" | "custody_certificate_malformed" | "custody_certificate_not_yet_valid" | "custody_certificate_expired" | "custody_p12_work_limit_exceeded" | "custody_signature_algorithm_unsupported" | "custody_certificate_trust_profile_unsupported" | "custody_certificate_chain_untrusted" | "custody_certificate_purpose_unsupported" | "legal_issuer_already_registered" | "onboarding_legal_issuer_identity_conflict" | "legal_issuer_profile_incomplete" | "legal_issuer_not_found" | "invitation_invalid" | "invitation_expired" | "already_a_member" | "environment_not_active" | "certificate_custody_binding_not_found" | "certificate_custody_binding_conflict" | "certificate_custody_certificate_version_not_active" | "source_connection_not_found" | "source_connection_not_connected" | "source_provider_unavailable" | "source_provider_authorization_required" | "source_provider_installation_disabled" | "source_provider_installation_removed" | "source_provider_scope_insufficient" | "source_provider_target_access_removed" | "source_provider_throttled" | "source_provider_outcome_unknown" | "source_provider_authorization_not_found" | "source_provider_authorization_conflict" | "source_provider_installation_request_invalid" | "source_provider_installation_request_expired" | "source_provider_installation_callback_replayed" | "source_connection_creation_conflict" | "source_connection_activation_conflict" | "source_connection_activation_verification_rejected" | "delegated_authorization_verifier_forbidden" | "invalid_credential" | "credential_revoked" | "issuer_not_authorized" | "missing_idempotency_key" | "invalid_idempotency_key" | "request_too_large" | "request_body_timeout" | "malformed_json" | "invalid_request" | "invalid_collection_query" | "invalid_collection_cursor" | "document_type_not_enabled" | "fiscal_intent_rejected" | "idempotency_key_conflict" | "fiscal_number_already_used" | "fiscal_number_authorization_changed" | "fiscal_number_authorization_source_record_conflict" | "source_version_stale" | "source_predecessor_conflict" | "source_history_requires_reconciliation" | "source_content_conflict" | "source_action_conflict" | "source_command_conflict" | "invoice_reference_conflict" | "invoice_totals_mismatch" | "printed_representation_profile_conflict" | "source_record_already_fiscalized" | "source_operation_pending" | "source_outcome_unknown" | "authority_rejected_replacement" | "correction_target_unsettled" | "unsupported_printed_representation_profile" | "affected_fiscal_operation_unsupported" | "fiscal_issuance_blocked" | "fiscal_operation_not_found" | "invoice_not_found" | "fiscal_artifact_not_found" | "fiscal_artifact_unverified" | "fiscal_artifact_unavailable" | "invoice_receipt_not_found" | "invoice_receipt_not_ready" | "invoice_receipt_unavailable" | "fiscal_delivery_not_found" | "fiscal_delivery_outcome_conflict" | "webhook_endpoint_registration_conflict" | "invalid_replay_scope" | "webhook_destination_not_allowed" | "unsigned_document_schema_invalid" | "signed_document_schema_invalid" | "custody_unavailable" | "received_document_not_found" | "commercial_response_motive_invalid" | "commercial_response_decision_conflict" | "method_not_allowed";
|
|
120
158
|
detail?: string;
|
|
121
159
|
/**
|
|
122
160
|
* Present only when the rejected request produced a Fiscal operation.
|
|
@@ -142,6 +180,40 @@ export type Problem = {
|
|
|
142
180
|
*/
|
|
143
181
|
type: "about:blank";
|
|
144
182
|
};
|
|
183
|
+
/**
|
|
184
|
+
* MerchantBusinessCertificationRequirement
|
|
185
|
+
*/
|
|
186
|
+
export type MerchantBusinessCertificationRequirement = {
|
|
187
|
+
code: "invoices_not_requested" | "fiscal_details_incomplete" | "certification_binding_required" | "certification_certificate_required" | "provider_eligibility_unverified" | "certification_receiver_urls_pending" | "certification_test_set_processing_unavailable";
|
|
188
|
+
owner: "merchant" | "dgii" | "timbro" | "operator";
|
|
189
|
+
blocks: Array<"start" | "step_1" | "step_2" | "step_7">;
|
|
190
|
+
field?: string;
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* MerchantBusinessCertificationStep
|
|
194
|
+
*/
|
|
195
|
+
export type MerchantBusinessCertificationStep = {
|
|
196
|
+
number: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
|
|
197
|
+
code: string;
|
|
198
|
+
title: string;
|
|
199
|
+
actor: "merchant" | "dgii" | "timbro";
|
|
200
|
+
status: "blocked" | "action_required" | "awaiting_dgii" | "reported" | "verified";
|
|
201
|
+
evidence: Array<MerchantBusinessCertificationEvidence>;
|
|
202
|
+
};
|
|
203
|
+
/**
|
|
204
|
+
* MerchantBusinessCertificationEvidence
|
|
205
|
+
*
|
|
206
|
+
* A business-reported DGII outcome. It remains unverified until an authorized evidence review confirms it.
|
|
207
|
+
*/
|
|
208
|
+
export type MerchantBusinessCertificationEvidence = {
|
|
209
|
+
id: string;
|
|
210
|
+
outcome: "submitted" | "approved" | "rejected" | "needs_correction";
|
|
211
|
+
verification: "user_reported" | "operator_verified" | "operator_rejected";
|
|
212
|
+
reference: string | null;
|
|
213
|
+
createdAt: string;
|
|
214
|
+
reviewedAt?: string;
|
|
215
|
+
reviewReference?: string;
|
|
216
|
+
};
|
|
145
217
|
export type RetrieveBusinessData = {
|
|
146
218
|
body?: never;
|
|
147
219
|
path?: never;
|
|
@@ -629,6 +701,469 @@ export type UpdateBusinessResponses = {
|
|
|
629
701
|
};
|
|
630
702
|
};
|
|
631
703
|
export type UpdateBusinessResponse = UpdateBusinessResponses[keyof UpdateBusinessResponses];
|
|
704
|
+
export type RetrieveMerchantBusinessCertificationData = {
|
|
705
|
+
body?: never;
|
|
706
|
+
path?: never;
|
|
707
|
+
query?: never;
|
|
708
|
+
url: "/v1/business/certification";
|
|
709
|
+
};
|
|
710
|
+
export type RetrieveMerchantBusinessCertificationErrors = {
|
|
711
|
+
/**
|
|
712
|
+
* The request could not be understood.
|
|
713
|
+
*/
|
|
714
|
+
400: Problem & {
|
|
715
|
+
status: 400;
|
|
716
|
+
/**
|
|
717
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
718
|
+
*/
|
|
719
|
+
code: "parameter_invalid";
|
|
720
|
+
};
|
|
721
|
+
/**
|
|
722
|
+
* The credential is missing, malformed, or no longer valid.
|
|
723
|
+
*/
|
|
724
|
+
401: Problem & {
|
|
725
|
+
status: 401;
|
|
726
|
+
/**
|
|
727
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
728
|
+
*/
|
|
729
|
+
code: "api_key_missing" | "api_key_invalid" | "checkout_token_invalid" | "checkout_token_expired" | "merchant_session_missing";
|
|
730
|
+
};
|
|
731
|
+
/**
|
|
732
|
+
* The credential is valid but not permitted to perform this operation.
|
|
733
|
+
*/
|
|
734
|
+
403: Problem & {
|
|
735
|
+
status: 403;
|
|
736
|
+
/**
|
|
737
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
738
|
+
*/
|
|
739
|
+
code: "operation_not_permitted";
|
|
740
|
+
};
|
|
741
|
+
/**
|
|
742
|
+
* No endpoint serves this method and path, or no resource with this identifier exists within the caller's scope.
|
|
743
|
+
*/
|
|
744
|
+
404: Problem & {
|
|
745
|
+
status: 404;
|
|
746
|
+
/**
|
|
747
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
748
|
+
*/
|
|
749
|
+
code: "merchant_business_not_found";
|
|
750
|
+
};
|
|
751
|
+
/**
|
|
752
|
+
* The request could not complete. Recover by the retained resource reference or retry with the same command identity.
|
|
753
|
+
*/
|
|
754
|
+
500: Problem & {
|
|
755
|
+
status: 500;
|
|
756
|
+
/**
|
|
757
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
758
|
+
*/
|
|
759
|
+
code: "internal_error";
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
export type RetrieveMerchantBusinessCertificationError = RetrieveMerchantBusinessCertificationErrors[keyof RetrieveMerchantBusinessCertificationErrors];
|
|
763
|
+
export type RetrieveMerchantBusinessCertificationResponses = {
|
|
764
|
+
/**
|
|
765
|
+
* MerchantBusinessCertification
|
|
766
|
+
*
|
|
767
|
+
* Durable certification preparation and user-reported DGII progress for the authenticated business.
|
|
768
|
+
*/
|
|
769
|
+
200: {
|
|
770
|
+
object: "merchant_business_certification";
|
|
771
|
+
status: "not_started";
|
|
772
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
773
|
+
availablePaths: Array<"own_software" | "external_software">;
|
|
774
|
+
recommendedPath: "own_software" | "external_software";
|
|
775
|
+
actions: Array<"start">;
|
|
776
|
+
} | {
|
|
777
|
+
object: "merchant_business_certification";
|
|
778
|
+
id: string;
|
|
779
|
+
revision: number;
|
|
780
|
+
status: "in_progress";
|
|
781
|
+
path: "own_software" | "external_software";
|
|
782
|
+
software: {
|
|
783
|
+
name: string;
|
|
784
|
+
version: string;
|
|
785
|
+
};
|
|
786
|
+
phase: "preparation" | "application" | "tests" | "authorization";
|
|
787
|
+
serviceUrls: {
|
|
788
|
+
reception: string;
|
|
789
|
+
commercialApproval: string;
|
|
790
|
+
} | null;
|
|
791
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
792
|
+
actions: Array<"report_evidence" | "import_certificate">;
|
|
793
|
+
steps: [
|
|
794
|
+
MerchantBusinessCertificationStep,
|
|
795
|
+
MerchantBusinessCertificationStep,
|
|
796
|
+
MerchantBusinessCertificationStep,
|
|
797
|
+
MerchantBusinessCertificationStep,
|
|
798
|
+
MerchantBusinessCertificationStep,
|
|
799
|
+
MerchantBusinessCertificationStep,
|
|
800
|
+
MerchantBusinessCertificationStep,
|
|
801
|
+
MerchantBusinessCertificationStep,
|
|
802
|
+
MerchantBusinessCertificationStep,
|
|
803
|
+
MerchantBusinessCertificationStep,
|
|
804
|
+
MerchantBusinessCertificationStep,
|
|
805
|
+
MerchantBusinessCertificationStep,
|
|
806
|
+
MerchantBusinessCertificationStep,
|
|
807
|
+
MerchantBusinessCertificationStep,
|
|
808
|
+
MerchantBusinessCertificationStep
|
|
809
|
+
];
|
|
810
|
+
};
|
|
811
|
+
};
|
|
812
|
+
export type RetrieveMerchantBusinessCertificationResponse = RetrieveMerchantBusinessCertificationResponses[keyof RetrieveMerchantBusinessCertificationResponses];
|
|
813
|
+
export type StartMerchantBusinessCertificationData = {
|
|
814
|
+
/**
|
|
815
|
+
* MerchantBusinessCertificationStartRequest
|
|
816
|
+
*/
|
|
817
|
+
body: {
|
|
818
|
+
path: "own_software" | "external_software";
|
|
819
|
+
};
|
|
820
|
+
headers: {
|
|
821
|
+
"idempotency-key": string;
|
|
822
|
+
};
|
|
823
|
+
path?: never;
|
|
824
|
+
query?: never;
|
|
825
|
+
url: "/v1/business/certification";
|
|
826
|
+
};
|
|
827
|
+
export type StartMerchantBusinessCertificationErrors = {
|
|
828
|
+
/**
|
|
829
|
+
* The request could not be understood.
|
|
830
|
+
*/
|
|
831
|
+
400: Problem & {
|
|
832
|
+
status: 400;
|
|
833
|
+
/**
|
|
834
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
835
|
+
*/
|
|
836
|
+
code: "parameter_invalid" | "parameter_missing" | "request_body_malformed";
|
|
837
|
+
};
|
|
838
|
+
/**
|
|
839
|
+
* The credential is missing, malformed, or no longer valid.
|
|
840
|
+
*/
|
|
841
|
+
401: Problem & {
|
|
842
|
+
status: 401;
|
|
843
|
+
/**
|
|
844
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
845
|
+
*/
|
|
846
|
+
code: "api_key_missing" | "api_key_invalid" | "checkout_token_invalid" | "checkout_token_expired" | "merchant_session_missing";
|
|
847
|
+
};
|
|
848
|
+
/**
|
|
849
|
+
* The credential is valid but not permitted to perform this operation.
|
|
850
|
+
*/
|
|
851
|
+
403: Problem & {
|
|
852
|
+
status: 403;
|
|
853
|
+
/**
|
|
854
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
855
|
+
*/
|
|
856
|
+
code: "operation_not_permitted";
|
|
857
|
+
};
|
|
858
|
+
/**
|
|
859
|
+
* No endpoint serves this method and path, or no resource with this identifier exists within the caller's scope.
|
|
860
|
+
*/
|
|
861
|
+
404: Problem & {
|
|
862
|
+
status: 404;
|
|
863
|
+
/**
|
|
864
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
865
|
+
*/
|
|
866
|
+
code: "merchant_business_not_found";
|
|
867
|
+
};
|
|
868
|
+
/**
|
|
869
|
+
* The request conflicts with the current state of the resource or with a previous request using the same Idempotency-Key.
|
|
870
|
+
*/
|
|
871
|
+
409: Problem & {
|
|
872
|
+
status: 409;
|
|
873
|
+
/**
|
|
874
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
875
|
+
*/
|
|
876
|
+
code: "idempotency_key_reused" | "idempotency_request_in_progress" | "idempotency_key_expired" | "merchant_business_certification_path_unavailable" | "merchant_business_certification_requirements_unmet";
|
|
877
|
+
};
|
|
878
|
+
/**
|
|
879
|
+
* The request body is larger than this endpoint accepts.
|
|
880
|
+
*/
|
|
881
|
+
413: Problem & {
|
|
882
|
+
status: 413;
|
|
883
|
+
/**
|
|
884
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
885
|
+
*/
|
|
886
|
+
code: "request_body_too_large";
|
|
887
|
+
};
|
|
888
|
+
/**
|
|
889
|
+
* The request body carries a content type this endpoint does not accept.
|
|
890
|
+
*/
|
|
891
|
+
415: Problem & {
|
|
892
|
+
status: 415;
|
|
893
|
+
/**
|
|
894
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
895
|
+
*/
|
|
896
|
+
code: "unsupported_media_type";
|
|
897
|
+
};
|
|
898
|
+
/**
|
|
899
|
+
* The request could not complete. Recover by the retained resource reference or retry with the same command identity.
|
|
900
|
+
*/
|
|
901
|
+
500: Problem & {
|
|
902
|
+
status: 500;
|
|
903
|
+
/**
|
|
904
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
905
|
+
*/
|
|
906
|
+
code: "internal_error";
|
|
907
|
+
};
|
|
908
|
+
/**
|
|
909
|
+
* A required service is temporarily unavailable. Retry with the same reference or command identity.
|
|
910
|
+
*/
|
|
911
|
+
503: Problem & {
|
|
912
|
+
status: 503;
|
|
913
|
+
/**
|
|
914
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
915
|
+
*/
|
|
916
|
+
code: "merchant_fiscal_setup_unavailable";
|
|
917
|
+
};
|
|
918
|
+
};
|
|
919
|
+
export type StartMerchantBusinessCertificationError = StartMerchantBusinessCertificationErrors[keyof StartMerchantBusinessCertificationErrors];
|
|
920
|
+
export type StartMerchantBusinessCertificationResponses = {
|
|
921
|
+
/**
|
|
922
|
+
* MerchantBusinessCertification
|
|
923
|
+
*
|
|
924
|
+
* Durable certification preparation and user-reported DGII progress for the authenticated business.
|
|
925
|
+
*/
|
|
926
|
+
200: {
|
|
927
|
+
object: "merchant_business_certification";
|
|
928
|
+
status: "not_started";
|
|
929
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
930
|
+
availablePaths: Array<"own_software" | "external_software">;
|
|
931
|
+
recommendedPath: "own_software" | "external_software";
|
|
932
|
+
actions: Array<"start">;
|
|
933
|
+
} | {
|
|
934
|
+
object: "merchant_business_certification";
|
|
935
|
+
id: string;
|
|
936
|
+
revision: number;
|
|
937
|
+
status: "in_progress";
|
|
938
|
+
path: "own_software" | "external_software";
|
|
939
|
+
software: {
|
|
940
|
+
name: string;
|
|
941
|
+
version: string;
|
|
942
|
+
};
|
|
943
|
+
phase: "preparation" | "application" | "tests" | "authorization";
|
|
944
|
+
serviceUrls: {
|
|
945
|
+
reception: string;
|
|
946
|
+
commercialApproval: string;
|
|
947
|
+
} | null;
|
|
948
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
949
|
+
actions: Array<"report_evidence" | "import_certificate">;
|
|
950
|
+
steps: [
|
|
951
|
+
MerchantBusinessCertificationStep,
|
|
952
|
+
MerchantBusinessCertificationStep,
|
|
953
|
+
MerchantBusinessCertificationStep,
|
|
954
|
+
MerchantBusinessCertificationStep,
|
|
955
|
+
MerchantBusinessCertificationStep,
|
|
956
|
+
MerchantBusinessCertificationStep,
|
|
957
|
+
MerchantBusinessCertificationStep,
|
|
958
|
+
MerchantBusinessCertificationStep,
|
|
959
|
+
MerchantBusinessCertificationStep,
|
|
960
|
+
MerchantBusinessCertificationStep,
|
|
961
|
+
MerchantBusinessCertificationStep,
|
|
962
|
+
MerchantBusinessCertificationStep,
|
|
963
|
+
MerchantBusinessCertificationStep,
|
|
964
|
+
MerchantBusinessCertificationStep,
|
|
965
|
+
MerchantBusinessCertificationStep
|
|
966
|
+
];
|
|
967
|
+
};
|
|
968
|
+
/**
|
|
969
|
+
* MerchantBusinessCertification
|
|
970
|
+
*
|
|
971
|
+
* Durable certification preparation and user-reported DGII progress for the authenticated business.
|
|
972
|
+
*/
|
|
973
|
+
201: {
|
|
974
|
+
object: "merchant_business_certification";
|
|
975
|
+
status: "not_started";
|
|
976
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
977
|
+
availablePaths: Array<"own_software" | "external_software">;
|
|
978
|
+
recommendedPath: "own_software" | "external_software";
|
|
979
|
+
actions: Array<"start">;
|
|
980
|
+
} | {
|
|
981
|
+
object: "merchant_business_certification";
|
|
982
|
+
id: string;
|
|
983
|
+
revision: number;
|
|
984
|
+
status: "in_progress";
|
|
985
|
+
path: "own_software" | "external_software";
|
|
986
|
+
software: {
|
|
987
|
+
name: string;
|
|
988
|
+
version: string;
|
|
989
|
+
};
|
|
990
|
+
phase: "preparation" | "application" | "tests" | "authorization";
|
|
991
|
+
serviceUrls: {
|
|
992
|
+
reception: string;
|
|
993
|
+
commercialApproval: string;
|
|
994
|
+
} | null;
|
|
995
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
996
|
+
actions: Array<"report_evidence" | "import_certificate">;
|
|
997
|
+
steps: [
|
|
998
|
+
MerchantBusinessCertificationStep,
|
|
999
|
+
MerchantBusinessCertificationStep,
|
|
1000
|
+
MerchantBusinessCertificationStep,
|
|
1001
|
+
MerchantBusinessCertificationStep,
|
|
1002
|
+
MerchantBusinessCertificationStep,
|
|
1003
|
+
MerchantBusinessCertificationStep,
|
|
1004
|
+
MerchantBusinessCertificationStep,
|
|
1005
|
+
MerchantBusinessCertificationStep,
|
|
1006
|
+
MerchantBusinessCertificationStep,
|
|
1007
|
+
MerchantBusinessCertificationStep,
|
|
1008
|
+
MerchantBusinessCertificationStep,
|
|
1009
|
+
MerchantBusinessCertificationStep,
|
|
1010
|
+
MerchantBusinessCertificationStep,
|
|
1011
|
+
MerchantBusinessCertificationStep,
|
|
1012
|
+
MerchantBusinessCertificationStep
|
|
1013
|
+
];
|
|
1014
|
+
};
|
|
1015
|
+
};
|
|
1016
|
+
export type StartMerchantBusinessCertificationResponse = StartMerchantBusinessCertificationResponses[keyof StartMerchantBusinessCertificationResponses];
|
|
1017
|
+
export type SubmitMerchantBusinessCertificationEvidenceData = {
|
|
1018
|
+
/**
|
|
1019
|
+
* MerchantBusinessCertificationEvidenceRequest
|
|
1020
|
+
*/
|
|
1021
|
+
body: {
|
|
1022
|
+
expectedRevision: number;
|
|
1023
|
+
step: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
|
|
1024
|
+
outcome: "submitted" | "approved" | "rejected" | "needs_correction";
|
|
1025
|
+
reference?: string;
|
|
1026
|
+
};
|
|
1027
|
+
headers: {
|
|
1028
|
+
"idempotency-key": string;
|
|
1029
|
+
};
|
|
1030
|
+
path?: never;
|
|
1031
|
+
query?: never;
|
|
1032
|
+
url: "/v1/business/certification/evidence";
|
|
1033
|
+
};
|
|
1034
|
+
export type SubmitMerchantBusinessCertificationEvidenceErrors = {
|
|
1035
|
+
/**
|
|
1036
|
+
* The request could not be understood.
|
|
1037
|
+
*/
|
|
1038
|
+
400: Problem & {
|
|
1039
|
+
status: 400;
|
|
1040
|
+
/**
|
|
1041
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1042
|
+
*/
|
|
1043
|
+
code: "parameter_invalid" | "parameter_missing" | "request_body_malformed";
|
|
1044
|
+
};
|
|
1045
|
+
/**
|
|
1046
|
+
* The credential is missing, malformed, or no longer valid.
|
|
1047
|
+
*/
|
|
1048
|
+
401: Problem & {
|
|
1049
|
+
status: 401;
|
|
1050
|
+
/**
|
|
1051
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1052
|
+
*/
|
|
1053
|
+
code: "api_key_missing" | "api_key_invalid" | "checkout_token_invalid" | "checkout_token_expired" | "merchant_session_missing";
|
|
1054
|
+
};
|
|
1055
|
+
/**
|
|
1056
|
+
* The credential is valid but not permitted to perform this operation.
|
|
1057
|
+
*/
|
|
1058
|
+
403: Problem & {
|
|
1059
|
+
status: 403;
|
|
1060
|
+
/**
|
|
1061
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1062
|
+
*/
|
|
1063
|
+
code: "operation_not_permitted";
|
|
1064
|
+
};
|
|
1065
|
+
/**
|
|
1066
|
+
* No endpoint serves this method and path, or no resource with this identifier exists within the caller's scope.
|
|
1067
|
+
*/
|
|
1068
|
+
404: Problem & {
|
|
1069
|
+
status: 404;
|
|
1070
|
+
/**
|
|
1071
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1072
|
+
*/
|
|
1073
|
+
code: "merchant_business_not_found";
|
|
1074
|
+
};
|
|
1075
|
+
/**
|
|
1076
|
+
* The request conflicts with the current state of the resource or with a previous request using the same Idempotency-Key.
|
|
1077
|
+
*/
|
|
1078
|
+
409: Problem & {
|
|
1079
|
+
status: 409;
|
|
1080
|
+
/**
|
|
1081
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1082
|
+
*/
|
|
1083
|
+
code: "idempotency_key_reused" | "idempotency_request_in_progress" | "idempotency_key_expired" | "merchant_business_certification_requirements_unmet" | "merchant_business_certification_revision_conflict";
|
|
1084
|
+
};
|
|
1085
|
+
/**
|
|
1086
|
+
* The request body is larger than this endpoint accepts.
|
|
1087
|
+
*/
|
|
1088
|
+
413: Problem & {
|
|
1089
|
+
status: 413;
|
|
1090
|
+
/**
|
|
1091
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1092
|
+
*/
|
|
1093
|
+
code: "request_body_too_large";
|
|
1094
|
+
};
|
|
1095
|
+
/**
|
|
1096
|
+
* The request body carries a content type this endpoint does not accept.
|
|
1097
|
+
*/
|
|
1098
|
+
415: Problem & {
|
|
1099
|
+
status: 415;
|
|
1100
|
+
/**
|
|
1101
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1102
|
+
*/
|
|
1103
|
+
code: "unsupported_media_type";
|
|
1104
|
+
};
|
|
1105
|
+
/**
|
|
1106
|
+
* The request could not complete. Recover by the retained resource reference or retry with the same command identity.
|
|
1107
|
+
*/
|
|
1108
|
+
500: Problem & {
|
|
1109
|
+
status: 500;
|
|
1110
|
+
/**
|
|
1111
|
+
* Stable machine-readable code. Branch on this, never on `title`.
|
|
1112
|
+
*/
|
|
1113
|
+
code: "internal_error";
|
|
1114
|
+
};
|
|
1115
|
+
};
|
|
1116
|
+
export type SubmitMerchantBusinessCertificationEvidenceError = SubmitMerchantBusinessCertificationEvidenceErrors[keyof SubmitMerchantBusinessCertificationEvidenceErrors];
|
|
1117
|
+
export type SubmitMerchantBusinessCertificationEvidenceResponses = {
|
|
1118
|
+
/**
|
|
1119
|
+
* MerchantBusinessCertification
|
|
1120
|
+
*
|
|
1121
|
+
* Durable certification preparation and user-reported DGII progress for the authenticated business.
|
|
1122
|
+
*/
|
|
1123
|
+
200: {
|
|
1124
|
+
object: "merchant_business_certification";
|
|
1125
|
+
status: "not_started";
|
|
1126
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
1127
|
+
availablePaths: Array<"own_software" | "external_software">;
|
|
1128
|
+
recommendedPath: "own_software" | "external_software";
|
|
1129
|
+
actions: Array<"start">;
|
|
1130
|
+
} | {
|
|
1131
|
+
object: "merchant_business_certification";
|
|
1132
|
+
id: string;
|
|
1133
|
+
revision: number;
|
|
1134
|
+
status: "in_progress";
|
|
1135
|
+
path: "own_software" | "external_software";
|
|
1136
|
+
software: {
|
|
1137
|
+
name: string;
|
|
1138
|
+
version: string;
|
|
1139
|
+
};
|
|
1140
|
+
phase: "preparation" | "application" | "tests" | "authorization";
|
|
1141
|
+
serviceUrls: {
|
|
1142
|
+
reception: string;
|
|
1143
|
+
commercialApproval: string;
|
|
1144
|
+
} | null;
|
|
1145
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
1146
|
+
actions: Array<"report_evidence" | "import_certificate">;
|
|
1147
|
+
steps: [
|
|
1148
|
+
MerchantBusinessCertificationStep,
|
|
1149
|
+
MerchantBusinessCertificationStep,
|
|
1150
|
+
MerchantBusinessCertificationStep,
|
|
1151
|
+
MerchantBusinessCertificationStep,
|
|
1152
|
+
MerchantBusinessCertificationStep,
|
|
1153
|
+
MerchantBusinessCertificationStep,
|
|
1154
|
+
MerchantBusinessCertificationStep,
|
|
1155
|
+
MerchantBusinessCertificationStep,
|
|
1156
|
+
MerchantBusinessCertificationStep,
|
|
1157
|
+
MerchantBusinessCertificationStep,
|
|
1158
|
+
MerchantBusinessCertificationStep,
|
|
1159
|
+
MerchantBusinessCertificationStep,
|
|
1160
|
+
MerchantBusinessCertificationStep,
|
|
1161
|
+
MerchantBusinessCertificationStep,
|
|
1162
|
+
MerchantBusinessCertificationStep
|
|
1163
|
+
];
|
|
1164
|
+
};
|
|
1165
|
+
};
|
|
1166
|
+
export type SubmitMerchantBusinessCertificationEvidenceResponse = SubmitMerchantBusinessCertificationEvidenceResponses[keyof SubmitMerchantBusinessCertificationEvidenceResponses];
|
|
632
1167
|
export type ConfigureInvoicingData = {
|
|
633
1168
|
/**
|
|
634
1169
|
* MerchantBusinessConfigureInvoicingRequest
|
|
@@ -756,6 +1291,10 @@ export type ImportSigningCertificateData = {
|
|
|
756
1291
|
mode: "test" | "live";
|
|
757
1292
|
certificateP12Base64: string;
|
|
758
1293
|
password: string;
|
|
1294
|
+
} | {
|
|
1295
|
+
purpose: "certification";
|
|
1296
|
+
certificateP12Base64: string;
|
|
1297
|
+
password: string;
|
|
759
1298
|
};
|
|
760
1299
|
path?: never;
|
|
761
1300
|
query?: never;
|
|
@@ -866,9 +1405,7 @@ export type ImportSigningCertificateErrors = {
|
|
|
866
1405
|
export type ImportSigningCertificateError = ImportSigningCertificateErrors[keyof ImportSigningCertificateErrors];
|
|
867
1406
|
export type ImportSigningCertificateResponses = {
|
|
868
1407
|
/**
|
|
869
|
-
*
|
|
870
|
-
*
|
|
871
|
-
* The business the credential selects, its capabilities, and the requirements that remain.
|
|
1408
|
+
* Default Response
|
|
872
1409
|
*/
|
|
873
1410
|
200: {
|
|
874
1411
|
object: "merchant_business";
|
|
@@ -988,6 +1525,47 @@ export type ImportSigningCertificateResponses = {
|
|
|
988
1525
|
}>;
|
|
989
1526
|
}>;
|
|
990
1527
|
onboardingUrl: string;
|
|
1528
|
+
} | {
|
|
1529
|
+
object: "merchant_business_certification";
|
|
1530
|
+
status: "not_started";
|
|
1531
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
1532
|
+
availablePaths: Array<"own_software" | "external_software">;
|
|
1533
|
+
recommendedPath: "own_software" | "external_software";
|
|
1534
|
+
actions: Array<"start">;
|
|
1535
|
+
} | {
|
|
1536
|
+
object: "merchant_business_certification";
|
|
1537
|
+
id: string;
|
|
1538
|
+
revision: number;
|
|
1539
|
+
status: "in_progress";
|
|
1540
|
+
path: "own_software" | "external_software";
|
|
1541
|
+
software: {
|
|
1542
|
+
name: string;
|
|
1543
|
+
version: string;
|
|
1544
|
+
};
|
|
1545
|
+
phase: "preparation" | "application" | "tests" | "authorization";
|
|
1546
|
+
serviceUrls: {
|
|
1547
|
+
reception: string;
|
|
1548
|
+
commercialApproval: string;
|
|
1549
|
+
} | null;
|
|
1550
|
+
requirements: Array<MerchantBusinessCertificationRequirement>;
|
|
1551
|
+
actions: Array<"report_evidence" | "import_certificate">;
|
|
1552
|
+
steps: [
|
|
1553
|
+
MerchantBusinessCertificationStep,
|
|
1554
|
+
MerchantBusinessCertificationStep,
|
|
1555
|
+
MerchantBusinessCertificationStep,
|
|
1556
|
+
MerchantBusinessCertificationStep,
|
|
1557
|
+
MerchantBusinessCertificationStep,
|
|
1558
|
+
MerchantBusinessCertificationStep,
|
|
1559
|
+
MerchantBusinessCertificationStep,
|
|
1560
|
+
MerchantBusinessCertificationStep,
|
|
1561
|
+
MerchantBusinessCertificationStep,
|
|
1562
|
+
MerchantBusinessCertificationStep,
|
|
1563
|
+
MerchantBusinessCertificationStep,
|
|
1564
|
+
MerchantBusinessCertificationStep,
|
|
1565
|
+
MerchantBusinessCertificationStep,
|
|
1566
|
+
MerchantBusinessCertificationStep,
|
|
1567
|
+
MerchantBusinessCertificationStep
|
|
1568
|
+
];
|
|
991
1569
|
};
|
|
992
1570
|
};
|
|
993
1571
|
export type ImportSigningCertificateResponse = ImportSigningCertificateResponses[keyof ImportSigningCertificateResponses];
|
|
@@ -1594,7 +2172,7 @@ export type CreateWebhookEndpointData = {
|
|
|
1594
2172
|
*
|
|
1595
2173
|
* Domain events that the gateway can deliver to a merchant endpoint.
|
|
1596
2174
|
*/
|
|
1597
|
-
enabledEvents: Array<"payment.succeeded" | "payment.canceled" | "payment.expired" | "payment.operator_required" | "refund.succeeded" | "refund.declined" | "refund.operator_required" | "refund.invoiceAttached" | "invoice.accepted" | "invoice.rejected" | "invoice.operatorRequired" | "invoice.ready">;
|
|
2175
|
+
enabledEvents: Array<"payment.succeeded" | "payment.declined" | "payment.canceled" | "payment.expired" | "payment.operator_required" | "refund.succeeded" | "refund.declined" | "refund.operator_required" | "refund.invoiceAttached" | "invoice.accepted" | "invoice.rejected" | "invoice.operatorRequired" | "invoice.ready" | "invoice.deliverySent" | "invoice.deliveryFailed">;
|
|
1598
2176
|
};
|
|
1599
2177
|
headers: {
|
|
1600
2178
|
"idempotency-key": string;
|