@timbro/payments 0.1.0-next.2 → 0.1.0-next.3
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
CHANGED
|
@@ -242,18 +242,18 @@ if (error !== undefined) {
|
|
|
242
242
|
type Requirement = components["schemas"]["MerchantBusinessRequirement"];
|
|
243
243
|
```
|
|
244
244
|
|
|
245
|
-
The facade covers every published merchant operation except `rotateApiKey
|
|
246
|
-
`
|
|
245
|
+
The facade covers every published merchant operation except `rotateApiKey` and
|
|
246
|
+
`chooseFiscalDocument`, which the client reaches directly.
|
|
247
247
|
|
|
248
248
|
## From a terminal
|
|
249
249
|
|
|
250
|
-
The published document is served at `https://api.timbro.
|
|
250
|
+
The published document is served at `https://api.timbro.do/openapi.json`, so a
|
|
251
251
|
generic OpenAPI client needs nothing from Timbro. With [Restish](https://rest.sh), register the
|
|
252
252
|
API once and pass a test administrator key on each call, from an environment variable rather than
|
|
253
253
|
your shell history:
|
|
254
254
|
|
|
255
255
|
```sh
|
|
256
|
-
restish api configure timbro https://api.timbro.
|
|
256
|
+
restish api configure timbro https://api.timbro.do
|
|
257
257
|
restish timbro retrieve-merchant-business -H "Authorization: Bearer $TIMBRO_ADMIN_KEY"
|
|
258
258
|
restish timbro update-merchant-business -H "Authorization: Bearer $TIMBRO_ADMIN_KEY" \
|
|
259
259
|
'capabilities.electronicInvoicing.requested: true'
|
|
@@ -631,26 +631,6 @@ export interface paths {
|
|
|
631
631
|
patch?: never;
|
|
632
632
|
trace?: never;
|
|
633
633
|
};
|
|
634
|
-
"/v1/diagnostics/pre-creation-requests": {
|
|
635
|
-
parameters: {
|
|
636
|
-
query?: never;
|
|
637
|
-
header?: never;
|
|
638
|
-
path?: never;
|
|
639
|
-
cookie?: never;
|
|
640
|
-
};
|
|
641
|
-
get?: never;
|
|
642
|
-
put?: never;
|
|
643
|
-
/**
|
|
644
|
-
* Record an attempt to create a Payment
|
|
645
|
-
* @description Retains one merchant-side creation attempt for 48 hours under the merchant's own request id, so an attempt that produced no Payment is still explainable. Repeating the same request id adds nothing.
|
|
646
|
-
*/
|
|
647
|
-
post: operations["createPreCreationJourneyRequest"];
|
|
648
|
-
delete?: never;
|
|
649
|
-
options?: never;
|
|
650
|
-
head?: never;
|
|
651
|
-
patch?: never;
|
|
652
|
-
trace?: never;
|
|
653
|
-
};
|
|
654
634
|
}
|
|
655
635
|
export interface webhooks {
|
|
656
636
|
"payment.succeeded": {
|
|
@@ -2770,41 +2750,6 @@ export interface components {
|
|
|
2770
2750
|
total: string;
|
|
2771
2751
|
};
|
|
2772
2752
|
};
|
|
2773
|
-
/**
|
|
2774
|
-
* JourneyObservationReceipt
|
|
2775
|
-
* @description What the Gateway retained. Diagnostics are best effort: a receipt reporting nothing accepted is a normal answer and never a reason to retry the journey.
|
|
2776
|
-
*/
|
|
2777
|
-
JourneyObservationReceipt: {
|
|
2778
|
-
/** @constant */
|
|
2779
|
-
object: "journey_observation_receipt";
|
|
2780
|
-
accepted: number;
|
|
2781
|
-
dropped: number;
|
|
2782
|
-
/**
|
|
2783
|
-
* @description Why the gate kept nothing. Absent when the batch reached the database, whatever it retained.
|
|
2784
|
-
* @enum {string}
|
|
2785
|
-
*/
|
|
2786
|
-
reason?: "gate_suspended" | "budget_exhausted" | "deadline_exceeded" | "write_failed" | "writer_busy";
|
|
2787
|
-
};
|
|
2788
|
-
/**
|
|
2789
|
-
* JourneyPreCreationRequest
|
|
2790
|
-
* @description One merchant-side attempt to create a Payment, recorded under the merchant's own request id so an attempt that never produced a Payment is still visible.
|
|
2791
|
-
*/
|
|
2792
|
-
JourneyPreCreationRequest: {
|
|
2793
|
-
/** @constant */
|
|
2794
|
-
contractVersion: 1;
|
|
2795
|
-
/** Format: uuid */
|
|
2796
|
-
requestId: string;
|
|
2797
|
-
saleReference: string;
|
|
2798
|
-
/** Format: date-time */
|
|
2799
|
-
startedAt: string;
|
|
2800
|
-
/** Format: date-time */
|
|
2801
|
-
finishedAt: string;
|
|
2802
|
-
/**
|
|
2803
|
-
* @description How the merchant's own attempt to create the Payment ended.
|
|
2804
|
-
* @enum {string}
|
|
2805
|
-
*/
|
|
2806
|
-
outcome: "created" | "gateway_error" | "rejected" | "network_error";
|
|
2807
|
-
};
|
|
2808
2753
|
/**
|
|
2809
2754
|
* MerchantAccount
|
|
2810
2755
|
* @description A merchant-owned provider account.
|
|
@@ -5780,7 +5725,7 @@ export interface components {
|
|
|
5780
5725
|
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
5781
5726
|
* @enum {string}
|
|
5782
5727
|
*/
|
|
5783
|
-
code: "merchant_authentication_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_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" | "journey_scope_mismatch" | "
|
|
5728
|
+
code: "merchant_authentication_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_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" | "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" | "refund_not_found" | "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_correction_not_allowed" | "fiscal_artifact_not_ready" | "fiscal_coordination_not_ready" | "fiscal_coordination_not_allowed" | "fiscal_reference_stale" | "fiscal_reference_conflict" | "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_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_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";
|
|
5784
5729
|
/** @description Correlation id, also returned as the Request-Id header. */
|
|
5785
5730
|
requestId: string;
|
|
5786
5731
|
/** @description Human-readable explanation of this occurrence. Branch on `code`, not on it. */
|
|
@@ -5793,7 +5738,7 @@ export interface components {
|
|
|
5793
5738
|
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
5794
5739
|
* @enum {string}
|
|
5795
5740
|
*/
|
|
5796
|
-
code: "merchant_authentication_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_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" | "journey_scope_mismatch" | "
|
|
5741
|
+
code: "merchant_authentication_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_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" | "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" | "refund_not_found" | "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_correction_not_allowed" | "fiscal_artifact_not_ready" | "fiscal_coordination_not_ready" | "fiscal_coordination_not_allowed" | "fiscal_reference_stale" | "fiscal_reference_conflict" | "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_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_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";
|
|
5797
5742
|
}[];
|
|
5798
5743
|
};
|
|
5799
5744
|
/** ProcessingFiscalDocument */
|
|
@@ -20597,224 +20542,6 @@ export interface operations {
|
|
|
20597
20542
|
};
|
|
20598
20543
|
};
|
|
20599
20544
|
};
|
|
20600
|
-
createPreCreationJourneyRequest: {
|
|
20601
|
-
parameters: {
|
|
20602
|
-
query?: never;
|
|
20603
|
-
header?: never;
|
|
20604
|
-
path?: never;
|
|
20605
|
-
cookie?: never;
|
|
20606
|
-
};
|
|
20607
|
-
/** @description One merchant-side attempt to create a Payment, recorded under the merchant's own request id so an attempt that never produced a Payment is still visible. */
|
|
20608
|
-
requestBody: {
|
|
20609
|
-
content: {
|
|
20610
|
-
"application/json": {
|
|
20611
|
-
/** @constant */
|
|
20612
|
-
contractVersion: 1;
|
|
20613
|
-
/** Format: uuid */
|
|
20614
|
-
requestId: string;
|
|
20615
|
-
saleReference: string;
|
|
20616
|
-
/** Format: date-time */
|
|
20617
|
-
startedAt: string;
|
|
20618
|
-
/** Format: date-time */
|
|
20619
|
-
finishedAt: string;
|
|
20620
|
-
/**
|
|
20621
|
-
* @description How the merchant's own attempt to create the Payment ended.
|
|
20622
|
-
* @enum {string}
|
|
20623
|
-
*/
|
|
20624
|
-
outcome: "created" | "gateway_error" | "rejected" | "network_error";
|
|
20625
|
-
};
|
|
20626
|
-
};
|
|
20627
|
-
};
|
|
20628
|
-
responses: {
|
|
20629
|
-
/** @description What the Gateway retained. Diagnostics are best effort: a receipt reporting nothing accepted is a normal answer and never a reason to retry the journey. */
|
|
20630
|
-
202: {
|
|
20631
|
-
headers: {
|
|
20632
|
-
[name: string]: unknown;
|
|
20633
|
-
};
|
|
20634
|
-
content: {
|
|
20635
|
-
"application/json": {
|
|
20636
|
-
/** @constant */
|
|
20637
|
-
object: "journey_observation_receipt";
|
|
20638
|
-
accepted: number;
|
|
20639
|
-
dropped: number;
|
|
20640
|
-
/**
|
|
20641
|
-
* @description Why the gate kept nothing. Absent when the batch reached the database, whatever it retained.
|
|
20642
|
-
* @enum {string}
|
|
20643
|
-
*/
|
|
20644
|
-
reason?: "gate_suspended" | "budget_exhausted" | "deadline_exceeded" | "write_failed" | "writer_busy";
|
|
20645
|
-
};
|
|
20646
|
-
};
|
|
20647
|
-
};
|
|
20648
|
-
/** @description The request could not be understood. */
|
|
20649
|
-
400: {
|
|
20650
|
-
headers: {
|
|
20651
|
-
[name: string]: unknown;
|
|
20652
|
-
};
|
|
20653
|
-
content: {
|
|
20654
|
-
"application/problem+json": components["schemas"]["Problem"] & {
|
|
20655
|
-
/** @constant */
|
|
20656
|
-
status: 400;
|
|
20657
|
-
/**
|
|
20658
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20659
|
-
* @enum {string}
|
|
20660
|
-
*/
|
|
20661
|
-
code: "parameter_invalid" | "parameter_missing" | "request_body_malformed";
|
|
20662
|
-
problems?: {
|
|
20663
|
-
/**
|
|
20664
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20665
|
-
* @enum {string}
|
|
20666
|
-
*/
|
|
20667
|
-
code: "parameter_invalid" | "parameter_missing" | "request_body_malformed";
|
|
20668
|
-
}[];
|
|
20669
|
-
};
|
|
20670
|
-
};
|
|
20671
|
-
};
|
|
20672
|
-
/** @description The credential is missing, malformed, or no longer valid. */
|
|
20673
|
-
401: {
|
|
20674
|
-
headers: {
|
|
20675
|
-
[name: string]: unknown;
|
|
20676
|
-
};
|
|
20677
|
-
content: {
|
|
20678
|
-
"application/problem+json": components["schemas"]["Problem"] & {
|
|
20679
|
-
/** @constant */
|
|
20680
|
-
status: 401;
|
|
20681
|
-
/**
|
|
20682
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20683
|
-
* @enum {string}
|
|
20684
|
-
*/
|
|
20685
|
-
code: "api_key_missing" | "api_key_invalid" | "checkout_token_invalid" | "checkout_token_expired";
|
|
20686
|
-
problems?: {
|
|
20687
|
-
/**
|
|
20688
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20689
|
-
* @enum {string}
|
|
20690
|
-
*/
|
|
20691
|
-
code: "api_key_missing" | "api_key_invalid" | "checkout_token_invalid" | "checkout_token_expired";
|
|
20692
|
-
}[];
|
|
20693
|
-
};
|
|
20694
|
-
};
|
|
20695
|
-
};
|
|
20696
|
-
/** @description The credential is valid but not permitted to perform this operation. */
|
|
20697
|
-
403: {
|
|
20698
|
-
headers: {
|
|
20699
|
-
[name: string]: unknown;
|
|
20700
|
-
};
|
|
20701
|
-
content: {
|
|
20702
|
-
"application/problem+json": components["schemas"]["Problem"] & {
|
|
20703
|
-
/** @constant */
|
|
20704
|
-
status: 403;
|
|
20705
|
-
/**
|
|
20706
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20707
|
-
* @enum {string}
|
|
20708
|
-
*/
|
|
20709
|
-
code: "operation_not_permitted";
|
|
20710
|
-
problems?: {
|
|
20711
|
-
/**
|
|
20712
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20713
|
-
* @enum {string}
|
|
20714
|
-
*/
|
|
20715
|
-
code: "operation_not_permitted";
|
|
20716
|
-
}[];
|
|
20717
|
-
};
|
|
20718
|
-
};
|
|
20719
|
-
};
|
|
20720
|
-
/** @description The request body is larger than this endpoint accepts. */
|
|
20721
|
-
413: {
|
|
20722
|
-
headers: {
|
|
20723
|
-
[name: string]: unknown;
|
|
20724
|
-
};
|
|
20725
|
-
content: {
|
|
20726
|
-
"application/problem+json": components["schemas"]["Problem"] & {
|
|
20727
|
-
/** @constant */
|
|
20728
|
-
status: 413;
|
|
20729
|
-
/**
|
|
20730
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20731
|
-
* @enum {string}
|
|
20732
|
-
*/
|
|
20733
|
-
code: "request_body_too_large";
|
|
20734
|
-
problems?: {
|
|
20735
|
-
/**
|
|
20736
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20737
|
-
* @enum {string}
|
|
20738
|
-
*/
|
|
20739
|
-
code: "request_body_too_large";
|
|
20740
|
-
}[];
|
|
20741
|
-
};
|
|
20742
|
-
};
|
|
20743
|
-
};
|
|
20744
|
-
/** @description The request body carries a content type this endpoint does not accept. */
|
|
20745
|
-
415: {
|
|
20746
|
-
headers: {
|
|
20747
|
-
[name: string]: unknown;
|
|
20748
|
-
};
|
|
20749
|
-
content: {
|
|
20750
|
-
"application/problem+json": components["schemas"]["Problem"] & {
|
|
20751
|
-
/** @constant */
|
|
20752
|
-
status: 415;
|
|
20753
|
-
/**
|
|
20754
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20755
|
-
* @enum {string}
|
|
20756
|
-
*/
|
|
20757
|
-
code: "unsupported_media_type";
|
|
20758
|
-
problems?: {
|
|
20759
|
-
/**
|
|
20760
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20761
|
-
* @enum {string}
|
|
20762
|
-
*/
|
|
20763
|
-
code: "unsupported_media_type";
|
|
20764
|
-
}[];
|
|
20765
|
-
};
|
|
20766
|
-
};
|
|
20767
|
-
};
|
|
20768
|
-
/** @description Too many requests. Retry after the interval in the Retry-After header. */
|
|
20769
|
-
429: {
|
|
20770
|
-
headers: {
|
|
20771
|
-
[name: string]: unknown;
|
|
20772
|
-
};
|
|
20773
|
-
content: {
|
|
20774
|
-
"application/problem+json": components["schemas"]["Problem"] & {
|
|
20775
|
-
/** @constant */
|
|
20776
|
-
status: 429;
|
|
20777
|
-
/**
|
|
20778
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20779
|
-
* @enum {string}
|
|
20780
|
-
*/
|
|
20781
|
-
code: "rate_limit_exceeded";
|
|
20782
|
-
problems?: {
|
|
20783
|
-
/**
|
|
20784
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20785
|
-
* @enum {string}
|
|
20786
|
-
*/
|
|
20787
|
-
code: "rate_limit_exceeded";
|
|
20788
|
-
}[];
|
|
20789
|
-
};
|
|
20790
|
-
};
|
|
20791
|
-
};
|
|
20792
|
-
/** @description The gateway failed before reaching a payment outcome. Retry with the same Idempotency-Key. */
|
|
20793
|
-
500: {
|
|
20794
|
-
headers: {
|
|
20795
|
-
[name: string]: unknown;
|
|
20796
|
-
};
|
|
20797
|
-
content: {
|
|
20798
|
-
"application/problem+json": components["schemas"]["Problem"] & {
|
|
20799
|
-
/** @constant */
|
|
20800
|
-
status: 500;
|
|
20801
|
-
/**
|
|
20802
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20803
|
-
* @enum {string}
|
|
20804
|
-
*/
|
|
20805
|
-
code: "internal_error";
|
|
20806
|
-
problems?: {
|
|
20807
|
-
/**
|
|
20808
|
-
* @description Stable machine-readable code. Branch on this, never on `title`.
|
|
20809
|
-
* @enum {string}
|
|
20810
|
-
*/
|
|
20811
|
-
code: "internal_error";
|
|
20812
|
-
}[];
|
|
20813
|
-
};
|
|
20814
|
-
};
|
|
20815
|
-
};
|
|
20816
|
-
};
|
|
20817
|
-
};
|
|
20818
20545
|
paymentSucceededWebhook: {
|
|
20819
20546
|
parameters: {
|
|
20820
20547
|
query?: never;
|