@gojinko/api-client 2.29.0 → 2.29.2

package/dist/types/generated.d.ts

@@ -2892,27 +2892,262 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Submit an agent payment — present trip_id + a Shared Payment Token to schedule + authorize the booking; returns a checkout_url fallback if customer action (3DS) is required */
+        /**
+         * Submit a typed card or SPT payment with Idempotency-Key, or a legacy flat Shared Payment Token
+         * @description Typed submissions require a jnk_ API key via X-API-Key (ApiKeyAuth) or Authorization: Bearer (BearerAuth), a tenant-bound booking scope, quoted_cart_id and Idempotency-Key, and return a PaymentAttemptOutcome (200 known outcome / 202 pending). OAuth/JWT bearer tokens are supported only for the legacy flat token body, which keeps its existing authorization response. Request bodies are limited to 16 KiB.
+         */
         post: {
             parameters: {
                 query?: never;
-                header?: never;
+                header?: {
+                    "Idempotency-Key"?: string;
+                };
                 path?: never;
                 cookie?: never;
             };
             requestBody?: {
                 content: {
-                    "application/json": components["schemas"]["AgentPaymentSubmitRequest"];
+                    "application/json": components["schemas"]["TypedAgentPaymentSubmitRequest"] | components["schemas"]["AgentPaymentSubmitRequest"];
+                };
+            };
+            responses: {
+                /** @description Legacy authorization result or typed payment outcome */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PaymentAttemptOutcome"] | components["schemas"]["AgentPaymentSubmitResponse"];
+                    };
+                };
+                /** @description Payment accepted and pending; poll the attempt after Retry-After. */
+                202: {
+                    headers: {
+                        /** @description Polling delay supplied by the BFF. */
+                        "Retry-After"?: string;
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PaymentAttemptOutcome"];
+                    };
+                };
+                /** @description Payment credential format or validity refusal. **`credential_format_invalid`** — The typed payment body or Idempotency-Key has an invalid format. Correct the named field and resubmit with a valid Idempotency-Key. **`payment_credential_invalid`** — The payment credential is invalid. Follow recovery.action and supply a replacement credential when required. **`BAD_REQUEST`** — The request was malformed or failed validation. Fix the request as the message describes; retrying it unchanged cannot succeed. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PaymentRefusalResponse"];
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "AUTH_REQUIRED",
+                         *         "message": "Invalid or expired API key.",
+                         *         "doc_url": "https://docs.gojinko.com/api-reference/authentication"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Payment required — organization balance exhausted */
+                402: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "PAYMENT_REQUIRED",
+                         *         "message": "Insufficient balance — this call costs $0.0150 and your organization has $0.0000 available. Top up at https://dashboard.gojinko.com/developers/billing/topup",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description This payment type is not enabled. **`payment_type_not_enabled`** — This payment type is not enabled for the caller. Choose a type advertised in accepted_payment_types or contact support. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PaymentRefusalResponse"];
+                    };
+                };
+                /** @description Resource not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "NOT_FOUND",
+                         *         "message": "Resource not found.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Payment submission conflicts with an existing attempt. **`trip_owned_by_other_payment`** — Another payment attempt owns this trip. Read the existing attempt and follow its recovery action before paying again. **`idempotency_key_reused`** — The idempotency key was already used for a different submission. Reuse the original request with this key, or use a new key for a new submission. **`attempt_in_progress`** — A payment attempt is already in progress. Poll the existing attempt and follow recovery.action. **`attempt_terminal`** — This payment attempt has reached a terminal state. Read its outcome and follow recovery.action before starting another attempt. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PaymentRefusalResponse"];
+                    };
+                };
+                /** @description The locked quote has expired, so nothing was redeemed and no payment object was created — or the resource the request names is gone. Tell the two apart by `error.code`. **`QUOTE_EXPIRED`** — The locked quote behind this checkout passed its `expires_at`, so payment was refused before any payment object was created. Call `POST /v1/checkout` again on the same trip — it re-quotes — then mint a new Shared Payment Token against the new `agent_spt_params` and submit that. Nothing was charged. **`GONE`** — The resource this request names existed and no longer does. Re-acquire it — search again, or check out again to re-quote — then retry with the new identifier. Repeating this request with the same one cannot succeed. **`quote_expired`** — The quoted cart has expired; the typed payment was refused. Call checkout again and submit against the new quoted_cart_id. */
+                410: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "QUOTE_EXPIRED",
+                         *         "message": "The quote behind this checkout expired at 2026-09-04T12:39:56Z.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       },
+                         *       "expires_at": "2026-09-04T12:39:56Z",
+                         *       "quoted_cart_id": 2097152
+                         *     }
+                         */
+                        "application/json": components["schemas"]["QuoteExpiredResponse"] | components["schemas"]["ErrorResponse"] | components["schemas"]["PaymentRefusalResponse"];
+                    };
+                };
+                /** @description Validation error */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "BAD_REQUEST",
+                         *         "message": "origins: origins is required; trip_type: trip_type is required",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Rate limit or quota exceeded */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "RATE_LIMITED",
+                         *         "message": "Rate limit or quota exceeded.",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description The travel provider rejected the request, or an upstream call failed */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "UPSTREAM_REJECTED",
+                         *         "message": "sabre-rest BargainFinderMaxRQ failed with status 400: 27131 - Number of connection locations exceeds maximum allowed",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Payment temporarily unavailable. **`temporarily_unavailable`** — Payment submission is temporarily unavailable. Wait for Retry-After when provided and follow recovery.action. */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["PaymentRefusalResponse"];
+                    };
+                };
+                /** @description The travel provider did not answer in time */
+                504: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": {
+                         *         "code": "UPSTREAM_TIMEOUT",
+                         *         "message": "sabre-rest BargainFinderMaxRQ timed out after 30s",
+                         *         "doc_url": "https://docs.gojinko.com/concepts/errors"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/trip/{trip_id}/payment_attempts/{payment_attempt_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Read a payment attempt outcome */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    trip_id: string;
+                    payment_attempt_id: string;
                 };
+                cookie?: never;
             };
+            requestBody?: never;
             responses: {
-                /** @description Authorization result */
+                /** @description Payment attempt outcome */
                 200: {
                     headers: {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["AgentPaymentSubmitResponse"];
+                        "application/json": components["schemas"]["PaymentAttemptOutcome"];
                     };
                 };
                 /** @description Bad request */
@@ -2969,6 +3204,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
+                /** @description Payment attempt access forbidden. **`FORBIDDEN`** — The credential is valid, and this request is refused anyway. Do not rotate the key — it is working. Check that it is entitled to this operation, and on this environment. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
                 /** @description Resource not found */
                 404: {
                     headers: {
@@ -3005,7 +3249,7 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
-                /** @description The locked quote has expired, so nothing was redeemed and no payment object was created — or the resource the request names is gone. Tell the two apart by `error.code`. **`QUOTE_EXPIRED`** — The locked quote behind this checkout passed its `expires_at`, so payment was refused before any payment object was created. Call `POST /v1/checkout` again on the same trip — it re-quotes — then mint a new Shared Payment Token against the new `agent_spt_params` and submit that. Nothing was charged. **`GONE`** — The resource this request names existed and no longer does. Re-acquire it — search again, or check out again to re-quote — then retry with the new identifier. Repeating this request with the same one cannot succeed. */
+                /** @description The resource this request names no longer exists */
                 410: {
                     headers: {
                         [name: string]: unknown;
@@ -3014,15 +3258,13 @@ export interface paths {
                         /**
                          * @example {
                          *       "error": {
-                         *         "code": "QUOTE_EXPIRED",
-                         *         "message": "The quote behind this checkout expired at 2026-09-04T12:39:56Z.",
+                         *         "code": "GONE",
+                         *         "message": "The resource no longer exists.",
                          *         "doc_url": "https://docs.gojinko.com/concepts/errors"
-                         *       },
-                         *       "expires_at": "2026-09-04T12:39:56Z",
-                         *       "quoted_cart_id": 2097152
+                         *       }
                          *     }
                          */
-                        "application/json": components["schemas"]["QuoteExpiredResponse"] | components["schemas"]["ErrorResponse"];
+                        "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
                 /** @description Validation error */
@@ -3119,6 +3361,8 @@ export interface paths {
                 };
             };
         };
+        put?: never;
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -11584,7 +11828,7 @@ export interface components {
                  * @example BAD_REQUEST
                  * @enum {string}
                  */
-                code: "AUTH_REQUIRED" | "PAYMENT_REQUIRED" | "RATE_LIMITED" | "BAD_REQUEST" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "GONE" | "QUOTE_EXPIRED" | "TRIP_EXPIRED" | "TRIP_STATE_CONFLICT" | "OFFER_EXPIRED" | "OFFER_UNAVAILABLE" | "MISSING_CUSTOMER_DETAILS" | "CURRENCY_UNSUPPORTED" | "HOTEL_NAME_LOW_CONFIDENCE" | "DESTINATION_LOW_CONFIDENCE" | "UPSTREAM_REJECTED" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_TIMEOUT" | "UPSTREAM_ERROR" | "INTERNAL";
+                code: "credential_format_invalid" | "payment_type_not_enabled" | "payment_credential_invalid" | "trip_owned_by_other_payment" | "idempotency_key_reused" | "attempt_in_progress" | "quote_expired" | "attempt_terminal" | "temporarily_unavailable" | "AUTH_REQUIRED" | "PAYMENT_REQUIRED" | "RATE_LIMITED" | "BAD_REQUEST" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "GONE" | "QUOTE_EXPIRED" | "TRIP_EXPIRED" | "TRIP_STATE_CONFLICT" | "OFFER_EXPIRED" | "OFFER_UNAVAILABLE" | "MISSING_CUSTOMER_DETAILS" | "CURRENCY_UNSUPPORTED" | "HOTEL_NAME_LOW_CONFIDENCE" | "DESTINATION_LOW_CONFIDENCE" | "UPSTREAM_REJECTED" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_TIMEOUT" | "UPSTREAM_ERROR" | "INTERNAL";
                 message: string;
                 doc_url?: string;
             };
@@ -12047,7 +12291,7 @@ export interface components {
                  * @example BAD_REQUEST
                  * @enum {string}
                  */
-                code: "AUTH_REQUIRED" | "PAYMENT_REQUIRED" | "RATE_LIMITED" | "BAD_REQUEST" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "GONE" | "QUOTE_EXPIRED" | "TRIP_EXPIRED" | "TRIP_STATE_CONFLICT" | "OFFER_EXPIRED" | "OFFER_UNAVAILABLE" | "MISSING_CUSTOMER_DETAILS" | "CURRENCY_UNSUPPORTED" | "HOTEL_NAME_LOW_CONFIDENCE" | "DESTINATION_LOW_CONFIDENCE" | "UPSTREAM_REJECTED" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_TIMEOUT" | "UPSTREAM_ERROR" | "INTERNAL";
+                code: "credential_format_invalid" | "payment_type_not_enabled" | "payment_credential_invalid" | "trip_owned_by_other_payment" | "idempotency_key_reused" | "attempt_in_progress" | "quote_expired" | "attempt_terminal" | "temporarily_unavailable" | "AUTH_REQUIRED" | "PAYMENT_REQUIRED" | "RATE_LIMITED" | "BAD_REQUEST" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "GONE" | "QUOTE_EXPIRED" | "TRIP_EXPIRED" | "TRIP_STATE_CONFLICT" | "OFFER_EXPIRED" | "OFFER_UNAVAILABLE" | "MISSING_CUSTOMER_DETAILS" | "CURRENCY_UNSUPPORTED" | "HOTEL_NAME_LOW_CONFIDENCE" | "DESTINATION_LOW_CONFIDENCE" | "UPSTREAM_REJECTED" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_TIMEOUT" | "UPSTREAM_ERROR" | "INTERNAL";
                 message: string;
                 doc_url?: string;
             };
@@ -12722,6 +12966,46 @@ export interface components {
             };
             intent?: components["schemas"]["IntentInput"];
         };
+        PaymentAttemptOutcome: {
+            payment_attempt_id: string;
+            trip_id: string;
+            quoted_cart_id: number;
+            fulfillment_cart_id?: number;
+            /** @enum {string} */
+            payment_status: "not_started" | "pending" | "requires_authentication" | "authorized" | "captured" | "declined" | "cancelling" | "cancelled" | "expired" | "failed";
+            booking_status: string;
+            booking_ref?: string;
+            payment_error: {
+                /** @enum {string} */
+                code: "credential_format_invalid" | "payment_type_not_enabled" | "payment_credential_invalid" | "trip_owned_by_other_payment" | "idempotency_key_reused" | "attempt_in_progress" | "card_declined" | "payment_credential_rejected" | "authentication_required" | "authentication_failed" | "authentication_abandoned" | "quote_expired" | "attempt_terminal" | "payment_outcome_unknown" | "fulfillment_dispatch_delayed" | "reconciliation_required" | "temporarily_unavailable";
+                message: string;
+            } | null;
+            recovery: {
+                /** @enum {string} */
+                action: "poll" | "authenticate" | "retry_same_key" | "retry_new_key" | "recheckout" | "contact_support" | "stop";
+                replacement_credential_required: boolean;
+            };
+            /** @enum {string} */
+            recovery_status: "automatic" | "manual_review";
+            /** Format: date-time */
+            quote_expires_at?: string;
+            retry_after_seconds?: number;
+            authentication?: {
+                url: string;
+                /** Format: date-time */
+                expires_at: string;
+            };
+            money?: {
+                authorized?: components["schemas"]["Money"];
+                captured?: components["schemas"]["Money"];
+                released?: components["schemas"]["Money"];
+                refunded?: components["schemas"]["Money"];
+                externally_reimbursed?: components["schemas"]["Money"];
+                /** @enum {string} */
+                resolution_status?: "pending" | "resolved" | "manual_review";
+                refund_reference?: string;
+            };
+        };
         BookingRef: {
             /** @example itm_4b91c2 */
             item_id?: string;
@@ -12756,6 +13040,7 @@ export interface components {
             hotel_id?: string;
         };
         GetTripResponse: {
+            payment_attempt?: components["schemas"]["PaymentAttemptOutcome"];
             /** @example trip_1048576 */
             trip_id: string;
             /**
@@ -12877,6 +13162,18 @@ export interface components {
             expires_at?: string;
         };
         CheckoutResponse: {
+            quoted_cart_id: number;
+            accepted_payment_types: {
+                /** @enum {string} */
+                type: "spt" | "card";
+                card_kinds?: ("customer_card" | "vcc")[];
+                requires: {
+                    headers: string[];
+                    fields: string[];
+                };
+                /** @enum {string} */
+                authentication: "customer_handoff" | "unavailable";
+            }[];
             /** @example cs_1048576 */
             session_id?: string;
             /** @example https://book.gojinko.com/checkout?sid=1048576 */
@@ -12921,6 +13218,18 @@ export interface components {
             checkout_url?: string;
             recap_token?: string;
         };
+        PaymentRefusalResponse: components["schemas"]["ErrorResponse"] & {
+            payment_error?: {
+                /** @enum {string} */
+                code: "credential_format_invalid" | "payment_type_not_enabled" | "payment_credential_invalid" | "trip_owned_by_other_payment" | "idempotency_key_reused" | "attempt_in_progress" | "card_declined" | "payment_credential_rejected" | "authentication_required" | "authentication_failed" | "authentication_abandoned" | "quote_expired" | "attempt_terminal" | "payment_outcome_unknown" | "fulfillment_dispatch_delayed" | "reconciliation_required" | "temporarily_unavailable";
+                message: string;
+            } | null;
+            recovery?: {
+                /** @enum {string} */
+                action: "poll" | "authenticate" | "retry_same_key" | "retry_new_key" | "recheckout" | "contact_support" | "stop";
+                replacement_credential_required: boolean;
+            };
+        };
         QuoteExpiredResponse: {
             error: {
                 /** @enum {string} */
@@ -12939,6 +13248,40 @@ export interface components {
              */
             quoted_cart_id?: number;
         };
+        TypedAgentPaymentSubmitRequest: {
+            trip_id: string;
+            quoted_cart_id: number;
+            payment: {
+                /** @enum {string} */
+                type: "spt";
+                shared_payment_token: string;
+            } | {
+                /** @enum {string} */
+                type: "card";
+                /** @enum {string} */
+                card_kind: "customer_card" | "vcc";
+                /** @description 12–19 digits after removing spaces, with a valid Luhn checksum. Forwarded unchanged. */
+                number: string;
+                exp_month: number;
+                /** @description Four-digit expiry year, at least the current UTC year. */
+                exp_year: number;
+                cvc: string;
+                billing_details?: {
+                    name?: string;
+                    /** Format: email */
+                    email?: string;
+                    phone?: string;
+                    address?: {
+                        line1?: string;
+                        line2?: string;
+                        city?: string;
+                        state?: string;
+                        postal_code?: string;
+                        country?: string;
+                    };
+                };
+            };
+        };
         AgentPaymentSubmitRequest: {
             /** @example trip_1048576 */
             trip_id: string;