{ "assess_evidence": { "definition": { "name": "assess_evidence", "description": "Assess the actual uploaded file against its target and declared purpose. Submission is not approval.", "parameters": { "type": "object", "properties": { "submission_id": { "type": "string", "description": "The actual uploaded evidence submission." } }, "required": [ "submission_id" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "evidence", "service": "desk_protocol", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-protocol", "rule_documents": [ "DESK-protocol" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "evidence", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_account_activation": { "definition": { "name": "propose_account_activation", "description": "Propose activation of an already provisioned collection account.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "accounts", "service": "kb_accounts_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-accounts-scope", "rule_documents": [ "KB-accounts-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "accounts", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_platform_cutover": { "definition": { "name": "propose_platform_cutover", "description": "Change future platform routing and store ownership after account activation and ownership evidence.", "parameters": { "type": "object", "properties": { "store_id": { "type": "string", "description": "The platform store." }, "account_id": { "type": "string", "description": "The account used by this operation." }, "submission_id": { "type": "string", "description": "The actual uploaded evidence submission." } }, "required": [ "store_id", "account_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "migration", "service": "ops_open_destination_cutover", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-open-destination-cutover", "rule_documents": [ "OPS-open-destination-cutover" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "migration", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_account_retirement": { "definition": { "name": "propose_account_retirement", "description": "Close an open zero-balance account. Closure does not redirect already transmitted funds.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "accounts", "service": "kb_accounts_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-accounts-effects", "rule_documents": [ "KB-accounts-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "accounts", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_balance_transfer": { "definition": { "name": "propose_balance_transfer", "description": "Move a specified credited USD balance between accessible accounts. Source restrictions survive transfers.", "parameters": { "type": "object", "properties": { "source_id": { "type": "string", "description": "The source account." }, "destination_id": { "type": "string", "description": "The destination account." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "source_id", "destination_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "migration", "service": "kb_migration_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-migration-effects", "rule_documents": [ "KB-migration-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "migration", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_conversion": { "definition": { "name": "inspect_conversion", "description": "Obtain an executable USD-to-CNY quote for a specified fund lot and quota allocation.", "parameters": { "type": "object", "properties": { "lot_id": { "type": "string", "description": "The source lot to inspect or use." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." }, "quota_allocations": { "type": "object", "description": "Map of quota IDs to allocated USD cents; the map supplies the complete allocation." } }, "required": [ "lot_id", "amount_minor", "quota_allocations" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "conversion", "service": "kb_conversion_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-conversion-scope", "rule_documents": [ "KB-conversion-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "conversion", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_conversion": { "definition": { "name": "propose_conversion", "description": "Propose execution of one unexpired conversion quote.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "The quote whose recorded terms are to be used." } }, "required": [ "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "conversion", "service": "kb_conversion_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-conversion-scope", "rule_documents": [ "KB-conversion-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "conversion", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_cny_withdrawal": { "definition": { "name": "propose_cny_withdrawal", "description": "Send CNY from an account to an existing verified CNY beneficiary.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "beneficiary_id": { "type": "string", "description": "The receiving bank record." }, "amount_minor": { "type": "integer", "description": "The requested principal in CNY minor units." } }, "required": [ "account_id", "beneficiary_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payments", "service": "ops_posted_cny_withdrawal", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-posted-cny-withdrawal", "rule_documents": [ "OPS-posted-cny-withdrawal" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "payments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_lot_payment": { "definition": { "name": "inspect_lot_payment", "description": "Quote a USD payment against a specified source lot. Quotes do not reserve availability.", "parameters": { "type": "object", "properties": { "lot_id": { "type": "string", "description": "The source lot to inspect or use." }, "beneficiary_id": { "type": "string", "description": "The receiving bank record." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "lot_id", "beneficiary_id", "amount_minor" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "provenance", "service": "iface_source_lot_payment", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Quotes and payments that preserve the provenance and permitted use of a source lot.", "interface_document": "IFACE-SOURCE-LOT-PAYMENT", "rule_documents": [ "IFACE-SOURCE-LOT-PAYMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "provenance", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_lot_payment": { "definition": { "name": "propose_lot_payment", "description": "Propose execution of one unexpired fund-lot payment quote.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "The quote whose recorded terms are to be used." } }, "required": [ "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "provenance", "service": "iface_source_lot_payment", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Quotes and payments that preserve the provenance and permitted use of a source lot.", "interface_document": "IFACE-SOURCE-LOT-PAYMENT", "rule_documents": [ "IFACE-SOURCE-LOT-PAYMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "provenance", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_bank_trace": { "definition": { "name": "propose_bank_trace", "description": "Request independent bank advice for a credited incoming transfer.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "The specific incoming transfer." } }, "required": [ "incoming_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tracing", "service": "kb_tracing_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-tracing-scope", "rule_documents": [ "KB-tracing-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "tracing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_reservation_cancellation": { "definition": { "name": "propose_reservation_cancellation", "description": "Cancel an open reservation and release its live resource occupancy. Expiry is not reversed.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "The existing resource reservation." } }, "required": [ "reservation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "quota", "service": "kb_quota_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-quota-scope", "rule_documents": [ "KB-quota-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "quota", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_credit_reversal": { "definition": { "name": "propose_credit_reversal", "description": "Reverse a credited incoming and its derived quota after occupied funds are released.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "The specific incoming transfer." } }, "required": [ "incoming_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "corrections", "service": "kb_corrections_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-corrections-effects", "rule_documents": [ "KB-corrections-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "corrections", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_credit_assignment": { "definition": { "name": "propose_credit_assignment", "description": "Assign an unapplied or reversed incoming to an accessible open account. Operator must establish the correct ownership.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "The specific incoming transfer." }, "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "incoming_id", "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "corrections", "service": "ops_reassign_an_already_reversed_credit", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-reassign-an-already-reversed-credit", "rule_documents": [ "OPS-reassign-an-already-reversed-credit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "corrections", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_beneficiary_update": { "definition": { "name": "propose_beneficiary_update", "description": "Apply current verified bank details; the beneficiary version increments after review.", "parameters": { "type": "object", "properties": { "beneficiary_id": { "type": "string", "description": "The receiving bank record." }, "submission_id": { "type": "string", "description": "The actual uploaded evidence submission." } }, "required": [ "beneficiary_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "beneficiaries", "service": "kb_beneficiaries_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-beneficiaries-scope", "rule_documents": [ "KB-beneficiaries-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "beneficiaries", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_bank_payment": { "definition": { "name": "inspect_bank_payment", "description": "Quote a USD payment for an obligation, a beneficiary version and an accessible account.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "beneficiary_id": { "type": "string", "description": "The receiving bank record." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "account_id", "beneficiary_id", "obligation_id", "amount_minor" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "payments", "service": "ops_ordinary_bank_cash", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-ordinary-bank-cash", "rule_documents": [ "OPS-ordinary-bank-cash" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "payments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_bank_payment": { "definition": { "name": "propose_bank_payment", "description": "Propose execution of a bank payment quote. Existing transfers are not automatically cancelled.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "The quote whose recorded terms are to be used." } }, "required": [ "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payments", "service": "ops_ordinary_bank_cash", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-ordinary-bank-cash", "rule_documents": [ "OPS-ordinary-bank-cash" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "payments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_request_cancellation": { "definition": { "name": "propose_request_cancellation", "description": "Cancel an unexecuted customer request. Cancellation does not cancel a sent payment.", "parameters": { "type": "object", "properties": { "request_id": { "type": "string", "description": "The unexecuted request to cancel." } }, "required": [ "request_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "consent", "service": "ops_cancel_an_unexecuted_payment_draft", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-cancel-an-unexecuted-payment-draft", "rule_documents": [ "OPS-cancel-an-unexecuted-payment-draft" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "consent", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_operator_role": { "definition": { "name": "propose_operator_role", "description": "Grant PAY to an already accepted active operator after a review delay.", "parameters": { "type": "object", "properties": { "operator_id": { "type": "string", "description": "The operator identity." } }, "required": [ "operator_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "permissions", "service": "kb_permissions_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-permissions-scope", "rule_documents": [ "KB-permissions-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "permissions", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_operator_revocation": { "definition": { "name": "propose_operator_revocation", "description": "Revoke an operator and increment its authorization epoch. Earlier approvals from it become invalid.", "parameters": { "type": "object", "properties": { "operator_id": { "type": "string", "description": "The operator identity." } }, "required": [ "operator_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "permissions", "service": "kb_permissions_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-permissions-effects", "rule_documents": [ "KB-permissions-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "permissions", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_authorized_disbursement": { "definition": { "name": "propose_authorized_disbursement", "description": "Prepare a specific obligation payment requiring an active PAY operator at approval and execution.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "beneficiary_id": { "type": "string", "description": "The receiving bank record." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "account_id", "beneficiary_id", "obligation_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "permissions", "service": "kb_permissions_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-permissions-scope", "rule_documents": [ "KB-permissions-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "permissions", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_card_authorizations": { "definition": { "name": "inspect_card_authorizations", "description": "Read active and historical authorizations for one card, including actual ledger occupancy.", "parameters": { "type": "object", "properties": { "card_id": { "type": "string", "description": "The selected card." } }, "required": [ "card_id" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "cards", "service": "iface_card_authorization_inspection", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Read-only inspection of card authorizations and their current network state.", "interface_document": "IFACE-CARD-AUTHORIZATION-INSPECTION", "rule_documents": [ "IFACE-CARD-AUTHORIZATION-INSPECTION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "cards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_authorization_void": { "definition": { "name": "propose_authorization_void", "description": "Ask the merchant to void one authorization. Merchant acknowledgement determines whether occupancy is released.", "parameters": { "type": "object", "properties": { "authorization_id": { "type": "string", "description": "The existing card authorization or capture." } }, "required": [ "authorization_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cards", "service": "kb_cards_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-cards-scope", "rule_documents": [ "KB-cards-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "cards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_card_funding_source": { "definition": { "name": "propose_card_funding_source", "description": "Change the account used for new card charges. Existing holds keep their original account.", "parameters": { "type": "object", "properties": { "card_id": { "type": "string", "description": "The selected card." }, "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "card_id", "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cards", "service": "kb_cards_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-cards-effects", "rule_documents": [ "KB-cards-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "cards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_card_purchase": { "definition": { "name": "propose_card_purchase", "description": "Pay a specified existing merchant invoice using the card current funding account.", "parameters": { "type": "object", "properties": { "card_id": { "type": "string", "description": "The selected card." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "card_id", "obligation_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cards", "service": "kb_cards_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-cards-effects", "rule_documents": [ "KB-cards-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "cards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_bank_identity_sync": { "definition": { "name": "propose_bank_identity_sync", "description": "Synchronize one bank account profile to the current registered legal identity.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "identity", "service": "kb_identity_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-identity-scope", "rule_documents": [ "KB-identity-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "identity", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "issue_bank_letter": { "definition": { "name": "issue_bank_letter", "description": "Issue an immutable account certificate describing the bank profile at issue time.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "account_id" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "letters", "service": "ops_ordinary_unaddressed_bank_letter", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-ordinary-unaddressed-bank-letter", "rule_documents": [ "OPS-ordinary-unaddressed-bank-letter" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "letters", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_platform_reverification": { "definition": { "name": "propose_platform_reverification", "description": "Submit a bank letter and current registry evidence for platform account review. An optional translation submission may be supplied.", "parameters": { "type": "object", "properties": { "store_id": { "type": "string", "description": "The platform store." }, "letter_id": { "type": "string", "description": "The issued account letter submitted for this review." }, "submission_id": { "type": "string", "description": "The actual uploaded evidence submission." }, "translation_submission_id": { "type": "string", "description": "Assessed translation evidence where the entity requires it." } }, "required": [ "store_id", "letter_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform", "service": "kb_platform_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-platform-scope", "rule_documents": [ "KB-platform-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "platform", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_order_refund": { "definition": { "name": "propose_order_refund", "description": "Refund a recorded sale to its original payer; the order quota is reduced at completion even if already consumed.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "The order whose refund is requested." } }, "required": [ "order_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "refunds", "service": "kb_refunds_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-refunds-scope", "rule_documents": [ "KB-refunds-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "refunds", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_sales_import": { "definition": { "name": "propose_sales_import", "description": "Import eligible, nonduplicate sales from an approved current statement; records generate quota, not cash.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "submission_id": { "type": "string", "description": "The actual uploaded evidence submission." } }, "required": [ "account_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "sales", "service": "kb_sales_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-sales-scope", "rule_documents": [ "KB-sales-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "sales", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_plan_charge": { "definition": { "name": "inspect_plan_charge", "description": "Quote a specified invoice using the currently effective plan and eligibility. This is not a future-cost optimizer.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." } }, "required": [ "account_id", "obligation_id" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "pricing", "service": "ops_plan_bank_pro_subscription", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-plan-bank-pro-subscription", "rule_documents": [ "OPS-plan-bank-pro-subscription" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "pricing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_plan_switch": { "definition": { "name": "propose_plan_switch", "description": "Activate a selected published plan. Charges already incurred and activation charges are not retroactively refunded.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "plan": { "type": "string", "description": "The named plan for the relevant subscription or tariff product." } }, "required": [ "account_id", "plan" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "pricing", "service": "iface_priced_payment", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Plan changes and payments whose fees depend on the active pricing plan.", "interface_document": "IFACE-PRICED-PAYMENT", "rule_documents": [ "IFACE-PRICED-PAYMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "pricing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_priced_payment": { "definition": { "name": "propose_priced_payment", "description": "Pay an existing eligible invoice under the plan effective at execution time.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "account_id", "obligation_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "pricing", "service": "iface_priced_payment", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Plan changes and payments whose fees depend on the active pricing plan.", "interface_document": "IFACE-PRICED-PAYMENT", "rule_documents": [ "IFACE-PRICED-PAYMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "pricing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_batch_review": { "definition": { "name": "propose_batch_review", "description": "Submit binding evidence and remittance evidence for the same sampled transfer. Review can release its linked batch in stages.", "parameters": { "type": "object", "properties": { "batch_id": { "type": "string", "description": "The batch under review." }, "binding_submission_id": { "type": "string", "description": "Assessed binding evidence for this batch and sample." }, "remittance_submission_id": { "type": "string", "description": "Assessed remittance evidence for the same batch and sample." } }, "required": [ "batch_id", "binding_submission_id", "remittance_submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "batches", "service": "kb_batches_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-batches-scope", "rule_documents": [ "KB-batches-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "batches", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_resource_occupancy": { "definition": { "name": "inspect_resource_occupancy", "description": "Inspect current holds and reservations on an account; the result does not forecast a complete payment plan.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "account_id" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "occupancy", "service": "kb_occupancy_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-occupancy-scope", "rule_documents": [ "KB-occupancy-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "occupancy", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_collection_application": { "definition": { "name": "propose_collection_application", "description": "Apply for a Collection Profile account matching an accessible legal entity registration region. Profile account terms are separate from CORE.", "parameters": { "type": "object", "properties": { "entity_id": { "type": "string", "description": "The registered legal entity." }, "profile_id": { "type": "string", "description": "The Collection Profile identifier." } }, "required": [ "entity_id", "profile_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "accounts", "service": "iface_collection_profiles", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Collection Profile product selection, account application and profile-specific payout.", "interface_document": "IFACE-COLLECTION-PROFILES", "rule_documents": [ "IFACE-COLLECTION-PROFILES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "accounts", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_profile_pricing": { "definition": { "name": "inspect_profile_pricing", "description": "Quote the current Collection Profile payout fee for an account and amount in its settlement currency.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "amount_minor": { "type": "integer", "description": "The requested principal in the account settlement currency minor units." } }, "required": [ "account_id", "amount_minor" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "pricing", "service": "iface_collection_profiles", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Collection Profile product selection, account application and profile-specific payout.", "interface_document": "IFACE-COLLECTION-PROFILES", "rule_documents": [ "IFACE-COLLECTION-PROFILES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "pricing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_profile_payout": { "definition": { "name": "propose_profile_payout", "description": "Pay from a Collection Profile account in its settlement currency, enforcing its per-payment minimum and daily principal cap.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "beneficiary_id": { "type": "string", "description": "The receiving bank record." }, "amount_minor": { "type": "integer", "description": "The requested principal in the account settlement currency minor units." } }, "required": [ "account_id", "beneficiary_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payments", "service": "iface_collection_profiles", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Collection Profile product selection, account application and profile-specific payout.", "interface_document": "IFACE-COLLECTION-PROFILES", "rule_documents": [ "IFACE-COLLECTION-PROFILES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "payments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_receivable_advance": { "definition": { "name": "propose_receivable_advance", "description": "Finance an identified transmitted receivable into a controlled-group accessible account. Principal is recovered from that receivable on arrival.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "The specific incoming transfer." }, "destination_id": { "type": "string", "description": "The destination account." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "incoming_id", "destination_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "liquidity", "service": "kb_liquidity_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-liquidity-scope", "rule_documents": [ "KB-liquidity-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "liquidity", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_source_payment": { "definition": { "name": "inspect_source_payment", "description": "Quote one recipient payment with an explicit allocation across eligible source lots.", "parameters": { "type": "object", "properties": { "beneficiary_id": { "type": "string", "description": "The receiving bank record." }, "allocations": { "type": "object", "description": "Map of source-lot IDs to positive USD cents, all in the same account." } }, "required": [ "beneficiary_id", "allocations" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "source_routes", "service": "ops_market_a_general_remittance", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-market-a-general-remittance", "rule_documents": [ "OPS-market-a-general-remittance" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "source_routes", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_source_payment": { "definition": { "name": "propose_source_payment", "description": "Execute a current source-allocation quote; source classifications and current availability apply.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "The quote whose recorded terms are to be used." } }, "required": [ "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "source_routes", "service": "kb_source_routes_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-source_routes-effects", "rule_documents": [ "KB-source_routes-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "source_routes", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_credit_note_allocation": { "definition": { "name": "propose_credit_note_allocation", "description": "Apply available commercial credit to one eligible invoice. Applied credit is not cash and is not refundable through this operation.", "parameters": { "type": "object", "properties": { "note_id": { "type": "string", "description": "The commercial credit note." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." } }, "required": [ "note_id", "obligation_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credits", "service": "kb_credits_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-credits-scope", "rule_documents": [ "KB-credits-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "credits", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_invoice_cash_discount": { "definition": { "name": "propose_invoice_cash_discount", "description": "Register an invoice cash-settlement concession if its recorded terms remain eligible.", "parameters": { "type": "object", "properties": { "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." } }, "required": [ "obligation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credits", "service": "kb_credits_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-credits-effects", "rule_documents": [ "KB-credits-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "credits", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_capture_refund": { "definition": { "name": "propose_capture_refund", "description": "Request reimbursement of a captured card amount identified by merchant advice.", "parameters": { "type": "object", "properties": { "authorization_id": { "type": "string", "description": "The existing card authorization or capture." } }, "required": [ "authorization_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "card_adjustments", "service": "ops_refund_an_advised_capture", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-refund-an-advised-capture", "rule_documents": [ "OPS-refund-an-advised-capture" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "card_adjustments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "issue_attested_bank_letter": { "definition": { "name": "issue_attested_bank_letter", "description": "Issue an immutable letter from the bank profile to a named addressee.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "addressee": { "type": "string", "description": "The addressee printed on the letter." } }, "required": [ "account_id", "addressee" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "attestations", "service": "ops_ordinary_unaddressed_bank_letter", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "OPS-ordinary-unaddressed-bank-letter", "rule_documents": [ "OPS-ordinary-unaddressed-bank-letter" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "attestations", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_platform_intake": { "definition": { "name": "propose_platform_intake", "description": "Register a platform review case within its published intake window using current registry evidence.", "parameters": { "type": "object", "properties": { "store_id": { "type": "string", "description": "The platform store." }, "submission_id": { "type": "string", "description": "The actual uploaded evidence submission." } }, "required": [ "store_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "attestations", "service": "kb_attestations_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-attestations-scope", "rule_documents": [ "KB-attestations-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "attestations", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_conversion_allocation_amendment": { "definition": { "name": "propose_conversion_allocation_amendment", "description": "Replace the quota allocation of an existing settled conversion without changing its cash leg.", "parameters": { "type": "object", "properties": { "payment_id": { "type": "string", "description": "The settled conversion to amend." }, "quota_allocations": { "type": "object", "description": "Map of quota IDs to allocated USD cents; the map supplies the complete allocation." } }, "required": [ "payment_id", "quota_allocations" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "quota_history", "service": "kb_quota_history_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-quota_history-scope", "rule_documents": [ "KB-quota_history-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "quota_history", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_tariff_enrolment": { "definition": { "name": "propose_tariff_enrolment", "description": "Register a tariff to start at a published billing slot. Replacing a pending instruction is permitted; posted charges remain.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "plan": { "type": "string", "description": "The named plan for the relevant subscription or tariff product." }, "slot_minute": { "type": "integer", "description": "The billing slot: 0, 30 or 60." } }, "required": [ "account_id", "plan", "slot_minute" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tariffs", "service": "iface_tariff_payment", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Tariff enrolment and payments governed by the resulting tariff terms.", "interface_document": "IFACE-TARIFF-PAYMENT", "rule_documents": [ "IFACE-TARIFF-PAYMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "tariffs", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_tariff_quote": { "definition": { "name": "inspect_tariff_quote", "description": "Quote a single payable invoice under the tariff and tier currently effective.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." } }, "required": [ "account_id", "obligation_id" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "tariffs", "service": "kb_tariffs_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-tariffs-effects", "rule_documents": [ "KB-tariffs-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "tariffs", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_tariff_payment": { "definition": { "name": "propose_tariff_payment", "description": "Submit one whole commercial invoice under current tariff terms.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." }, "obligation_id": { "type": "string", "description": "The commercial obligation being paid or inspected." } }, "required": [ "account_id", "obligation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tariffs", "service": "iface_tariff_payment", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Tariff enrolment and payments governed by the resulting tariff terms.", "interface_document": "IFACE-TARIFF-PAYMENT", "rule_documents": [ "IFACE-TARIFF-PAYMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "tariffs", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_tariff_rebate": { "definition": { "name": "propose_tariff_rebate", "description": "Claim the available fixed contractual rebate on settled qualifying invoices in the current period.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "The account used by this operation." } }, "required": [ "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "rebates", "service": "kb_rebates_scope", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-rebates-scope", "rule_documents": [ "KB-rebates-scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "rebates", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_source_reclassification": { "definition": { "name": "propose_source_reclassification", "description": "Submit source evidence for a specified portion of an existing settlement lot. Approved reclassification creates a separate traceable lot.", "parameters": { "type": "object", "properties": { "lot_id": { "type": "string", "description": "The source lot to inspect or use." }, "amount_minor": { "type": "integer", "description": "The requested principal in USD cents." }, "submission_id": { "type": "string", "description": "The actual uploaded evidence submission." } }, "required": [ "lot_id", "amount_minor", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "classification", "service": "kb_classification_effects", "portal": "operations_desk", "applicable_entity": "CORE settlement service. Effective 2026-09-01.", "interface_document": "KB-classification-effects", "rule_documents": [ "KB-classification-effects" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "classification", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_authorization": { "definition": { "name": "propose_portal_authorization", "description": "Authorize or cancel one seller connection for a specific Portal account.", "parameters": { "type": "object", "properties": { "store_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "store_id", "account_id", "action" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_authorization", "service": "portal_authorization", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-authorization", "rule_documents": [ "PORTAL-authorization" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_authorization", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_sales_import": { "definition": { "name": "propose_portal_sales_import", "description": "Import assessed historical sales evidence for one authorized store; duplicates do not add quota.", "parameters": { "type": "object", "properties": { "store_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "store_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_authorization", "service": "portal_authorization", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-authorization", "rule_documents": [ "PORTAL-authorization" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_authorization", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_portal_payment": { "definition": { "name": "inspect_portal_payment", "description": "Quote a Portal bank payment or USD-to-CNY withdrawal using current tariff, bank and security versions.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "recipient_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "currency": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "reference": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "account_id", "recipient_id", "amount_minor", "currency", "reference" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "portal_payments", "service": "portal_payments", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-payments", "rule_documents": [ "PORTAL-payments" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_payments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_payment": { "definition": { "name": "propose_portal_payment", "description": "Submit a quoted Portal payment; settlement is a later event.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_payments", "service": "portal_payments", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-payments", "rule_documents": [ "PORTAL-payments" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_payments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_contact_change": { "definition": { "name": "propose_portal_contact_change", "description": "Submit account-recovery evidence for a phone change. Review does not immediately restore SMS.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "account_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_security", "service": "portal_security", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-security", "rule_documents": [ "PORTAL-security" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_security", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_verification": { "definition": { "name": "propose_portal_verification", "description": "Issue a customer verification challenge on SMS or EMAIL; channels have different business uses.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "account_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_security", "service": "portal_security", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-security", "rule_documents": [ "PORTAL-security" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_security", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_rmb_registration": { "definition": { "name": "propose_rmb_registration", "description": "Register the declared reporting party for an HK company CNY service.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "reporting_party": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "account_id", "reporting_party", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_rmb", "service": "portal_rmb", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-rmb", "rule_documents": [ "PORTAL-rmb" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_rmb", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_recipient_verification": { "definition": { "name": "propose_portal_recipient_verification", "description": "Submit current recipient identity and bank evidence for asynchronous verification.", "parameters": { "type": "object", "properties": { "recipient_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "recipient_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_recipients", "service": "portal_recipients", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-recipients", "rule_documents": [ "PORTAL-recipients" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_recipients", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_group_invitation": { "definition": { "name": "propose_group_invitation", "description": "Invite a controlled child account to a parent group; pending invitations occupy places.", "parameters": { "type": "object", "properties": { "group_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "child_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "group_id", "child_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_groups", "service": "portal_groups", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-groups", "rule_documents": [ "PORTAL-groups" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_groups", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_group_unbinding": { "definition": { "name": "propose_group_unbinding", "description": "Cancel a pending invitation or request a delayed unbinding of an active child.", "parameters": { "type": "object", "properties": { "member_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "member_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_groups", "service": "portal_groups", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-groups", "rule_documents": [ "PORTAL-groups" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_groups", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_group_expansion": { "definition": { "name": "propose_group_expansion", "description": "Request five additional places; qualifying volume and active membership are checked at review.", "parameters": { "type": "object", "properties": { "group_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "group_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_groups", "service": "portal_groups", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-groups", "rule_documents": [ "PORTAL-groups" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_groups", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_bank_trace": { "definition": { "name": "propose_portal_bank_trace", "description": "Request independent origin advice for one closed-account receipt.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "incoming_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_returns", "service": "portal_returns", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-returns", "rule_documents": [ "PORTAL-returns" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_returns", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_return": { "definition": { "name": "propose_portal_return", "description": "Return a specified amount of a held receipt through ORIGINAL or ALTERNATIVE routing.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "route": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "recipient_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "incoming_id", "amount_minor", "route", "recipient_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_returns", "service": "portal_returns", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-returns", "rule_documents": [ "PORTAL-returns" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_returns", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_card_void": { "definition": { "name": "propose_portal_card_void", "description": "Send a merchant void request for an authorization; the merchant determines capture and release.", "parameters": { "type": "object", "properties": { "hold_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "hold_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_cards", "service": "portal_cards", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-cards", "rule_documents": [ "PORTAL-cards" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_cards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_card_funding": { "definition": { "name": "propose_portal_card_funding", "description": "Set the account for new card purchases; existing holds remain with their original account.", "parameters": { "type": "object", "properties": { "card_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "card_id", "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_cards", "service": "portal_cards", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-cards", "rule_documents": [ "PORTAL-cards" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_cards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_card_purchase": { "definition": { "name": "propose_portal_card_purchase", "description": "Submit a new card purchase for a specific invoice using the card funding account.", "parameters": { "type": "object", "properties": { "card_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "invoice_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "card_id", "invoice_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_cards", "service": "portal_cards", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-cards", "rule_documents": [ "PORTAL-cards" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_cards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_portal_fee_share": { "definition": { "name": "propose_portal_fee_share", "description": "Request a relationship-based tariff; an application fee is charged even if review rejects it.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "agreement_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "account_id", "agreement_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "portal_fees", "service": "portal_fees", "portal": "operations_desk", "applicable_entity": "Marketplace Portal API integration v4.0.0. Applies from service minute 0.", "interface_document": "PORTAL-fees", "rule_documents": [ "PORTAL-fees" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "portal_fees", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_bridge_draw": { "definition": { "name": "propose_bridge_draw", "description": "Draw a receivable bridge under the selected facility; collateral and repayment remain live.", "parameters": { "type": "object", "properties": { "facility_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "facility_id", "account_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "bridge", "service": "rst_bridge", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-bridge", "rule_documents": [ "RST-bridge" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "bridge", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_bridge_repayment": { "definition": { "name": "propose_bridge_repayment", "description": "Repay the entire outstanding bridge from its borrowing account.", "parameters": { "type": "object", "properties": { "facility_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "facility_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "bridge", "service": "rst_bridge", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-bridge", "rule_documents": [ "RST-bridge" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "bridge", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_credit_redemption": { "definition": { "name": "propose_credit_redemption", "description": "Redeem a supplier credit using EARLY or SETTLEMENT terms.", "parameters": { "type": "object", "properties": { "note_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "method": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "note_id", "method" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "redemption", "service": "rst_redemption", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-redemption", "rule_documents": [ "RST-redemption" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "redemption", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_legalization_booking": { "definition": { "name": "propose_legalization_booking", "description": "Reserve a CURRENT or FORWARD legalization slot before intake closes.", "parameters": { "type": "object", "properties": { "slot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "mode": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "slot_id", "mode" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "legalization", "service": "rst_legalization", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-legalization", "rule_documents": [ "RST-legalization" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "legalization", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_letter_legalization": { "definition": { "name": "propose_letter_legalization", "description": "Submit an issued bank letter to a reserved legalization slot.", "parameters": { "type": "object", "properties": { "slot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "letter_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "slot_id", "letter_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "legalization", "service": "rst_legalization", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-legalization", "rule_documents": [ "RST-legalization" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "legalization", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_marketplace_adjustment": { "definition": { "name": "propose_marketplace_adjustment", "description": "Book a notified marketplace debit as SALES_RETURN or SERVICE_FEE.", "parameters": { "type": "object", "properties": { "adjustment_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "classification": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "adjustment_id", "classification" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "adjustments", "service": "rst_adjustments", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-adjustments", "rule_documents": [ "RST-adjustments" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "adjustments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_delegate_adoption": { "definition": { "name": "propose_delegate_adoption", "description": "Bind a delegate to the currently SMS-verified account security context.", "parameters": { "type": "object", "properties": { "delegate_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "delegate_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "delegates", "service": "rst_delegates", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-delegates", "rule_documents": [ "RST-delegates" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "delegates", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_delegate_revocation": { "definition": { "name": "propose_delegate_revocation", "description": "Revoke a Portal delegate; recovery ownership and SMS proof are affected.", "parameters": { "type": "object", "properties": { "delegate_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "delegate_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "delegates", "service": "rst_delegates", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-delegates", "rule_documents": [ "RST-delegates" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "delegates", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_export_allocation": { "definition": { "name": "propose_export_allocation", "description": "Reserve current declaration capacity for an account payment.", "parameters": { "type": "object", "properties": { "declaration_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "declaration_id", "account_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "declarations", "service": "rst_declarations", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-declarations", "rule_documents": [ "RST-declarations" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "declarations", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_export_release": { "definition": { "name": "propose_export_release", "description": "Release an unconsumed declaration allocation.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "allocation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "declarations", "service": "rst_declarations", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-declarations", "rule_documents": [ "RST-declarations" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "declarations", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_volume_certificate": { "definition": { "name": "propose_volume_certificate", "description": "Certify CURRENT_ROLLING or LOCKED_PERIOD qualifying source rows and active membership.", "parameters": { "type": "object", "properties": { "group_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "basis": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "group_id", "basis" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "volume", "service": "rst_volume", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-volume", "rule_documents": [ "RST-volume" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "volume", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_return_routing": { "definition": { "name": "propose_return_routing", "description": "Set DIRECT or AGGREGATE routing for a traced return.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "route_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "incoming_id", "route_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "return_routing", "service": "rst_return_routing", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-return-routing", "rule_documents": [ "RST-return-routing" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "return-routing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_return_allocation": { "definition": { "name": "propose_return_allocation", "description": "Credit a settled aggregate return to a dated buyer allocation instruction.", "parameters": { "type": "object", "properties": { "refund_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "instruction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "refund_id", "instruction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "return_routing", "service": "rst_return_routing", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-return-routing", "rule_documents": [ "RST-return-routing" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "return-routing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_card_limit_transfer": { "definition": { "name": "propose_card_limit_transfer", "description": "Reallocate daily purchase capacity between cards in one company pool.", "parameters": { "type": "object", "properties": { "source_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "destination_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "source_id", "destination_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "card_limits", "service": "rst_card_limits", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-card-limits", "rule_documents": [ "RST-card-limits" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "card-limits", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_fee_guarantee": { "definition": { "name": "propose_fee_guarantee", "description": "Deposit a refundable tariff guarantee under CASH or MARGIN coverage.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "coverage": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "account_id", "coverage", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "fee_guarantee", "service": "rst_fee_guarantee", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-fee-guarantee", "rule_documents": [ "RST-fee-guarantee" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "fee-guarantee", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_fee_guarantee_release": { "definition": { "name": "propose_fee_guarantee_release", "description": "Cancel an unbound deposit or release it after its remittance settles.", "parameters": { "type": "object", "properties": { "guarantee_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "guarantee_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "fee_guarantee", "service": "rst_fee_guarantee", "portal": "operations_desk", "applicable_entity": "CORE or Marketplace Portal accounts with the corresponding optional product records, service profile 4.1.0. Existing base product rules apply alongside these additional terms.", "interface_document": "RST-fee-guarantee", "rule_documents": [ "RST-fee-guarantee" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "fee-guarantee", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_capacity_reservations": { "definition": { "name": "propose_capacity_reservations", "description": "Atomically reserve an explicit caller-supplied allocation map: obligation ID to pool ID to integer quantity. This executes the supplied allocation and does not select or optimize a plan.", "parameters": { "type": "object", "properties": { "allocations": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "allocations" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_capacity", "service": "cap_operations", "portal": "operations_desk", "applicable_entity": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.", "interface_document": "CAP-operations", "rule_documents": [ "CAP-operations" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "shared-capacity", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_capacity_reservation": { "definition": { "name": "propose_capacity_reservation", "description": "Reserve a stated quantity of operational coverage from one pool for one obligation. Actual pool debit follows its published coverage ratio. A reservation is not completion.", "parameters": { "type": "object", "properties": { "pool_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "obligation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "quantity": { "type": "integer", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "pool_id", "obligation_id", "quantity" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_capacity", "service": "iface_capacity_reservations", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Capacity reservations and releases shared by the documented product services.", "interface_document": "IFACE-CAPACITY-RESERVATIONS", "rule_documents": [ "IFACE-CAPACITY-RESERVATIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "shared-capacity", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_capacity_release": { "definition": { "name": "propose_capacity_release", "description": "Release an unused operational coverage reservation. Consumed coverage cannot be released through this tool.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "reservation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_capacity", "service": "iface_capacity_reservations", "portal": "operations_desk", "applicable_entity": "PSP product accounts; Capacity reservations and releases shared by the documented product services.", "interface_document": "IFACE-CAPACITY-RESERVATIONS", "rule_documents": [ "IFACE-CAPACITY-RESERVATIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "topic": "shared-capacity", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_remittance_advice": { "definition": { "name": "propose_remittance_advice", "description": "Request an authoritative remittance advice revision. A trace request is not confirmation of invoice allocation.", "parameters": { "type": "object", "properties": { "remittance_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "remittance_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "reconciliation", "service": "desk_reconciliation", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-reconciliation", "rule_documents": [ "DESK-reconciliation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-reconciliation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_invoice_allocation": { "definition": { "name": "propose_invoice_allocation", "description": "Replace the reversible invoice allocation of one posted remittance, recording the advice used. Does not alter bank cash.", "parameters": { "type": "object", "properties": { "remittance_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "advice_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "allocations": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "remittance_id", "advice_id", "allocations" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "reconciliation", "service": "desk_reconciliation", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-reconciliation", "rule_documents": [ "DESK-reconciliation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-reconciliation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_receivable_close": { "definition": { "name": "propose_receivable_close", "description": "Close a receivables portfolio and freeze its allocations. Accepted closure does not certify customer intent or full reconciliation.", "parameters": { "type": "object", "properties": { "portfolio_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "portfolio_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "reconciliation", "service": "desk_reconciliation", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-reconciliation", "rule_documents": [ "DESK-reconciliation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-reconciliation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_attempt_trace": { "definition": { "name": "propose_attempt_trace", "description": "Request the bank receipt for a submission attempt whose acknowledgement is pending.", "parameters": { "type": "object", "properties": { "attempt_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "attempt_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "batches", "service": "desk_batches", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-batches", "rule_documents": [ "DESK-batches" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-batches", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_batch_recipient_update": { "definition": { "name": "propose_batch_recipient_update", "description": "Update the recipient version of one unpaid batch item from approved bank evidence. Does not cancel previously transmitted instructions.", "parameters": { "type": "object", "properties": { "item_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "item_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "batches", "service": "desk_batches", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-batches", "rule_documents": [ "DESK-batches" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-batches", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_batch_item_payment": { "definition": { "name": "propose_batch_item_payment", "description": "Submit the amount of a batch item with an explicit bank version and idempotency key. A new key can create another payment; the caller must establish whether another submission is needed.", "parameters": { "type": "object", "properties": { "item_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "bank_version": { "type": "integer", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "submission_key": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "item_id", "bank_version", "submission_key" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "batches", "service": "desk_batches", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-batches", "rule_documents": [ "DESK-batches" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-batches", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_bank_message_amendment": { "definition": { "name": "propose_bank_message_amendment", "description": "Request a reference and tax-period amendment for an amendable bank transfer. Its recipient and principal are immutable.", "parameters": { "type": "object", "properties": { "transfer_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "tax_period": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "tax_reference": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "transfer_id", "tax_period", "tax_reference" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax", "service": "desk_tax", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-tax", "rule_documents": [ "DESK-tax" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-tax", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_tax_allocation": { "definition": { "name": "propose_tax_allocation", "description": "Ask the tax authority to assign an existing payment to explicit period amounts using approved evidence. No new cash payment is made.", "parameters": { "type": "object", "properties": { "transfer_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "allocations": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "transfer_id", "allocations", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax", "service": "desk_tax", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-tax", "rule_documents": [ "DESK-tax" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-tax", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_onboarding_bundle": { "definition": { "name": "propose_onboarding_bundle", "description": "Assemble a versioned set of assessed evidence for an application. submission_ids is an object with submission IDs as keys and true as values.", "parameters": { "type": "object", "properties": { "application_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_ids": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "application_id", "submission_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "onboarding", "service": "desk_onboarding", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-onboarding", "rule_documents": [ "DESK-onboarding" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-onboarding", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_onboarding_submission": { "definition": { "name": "propose_onboarding_submission", "description": "Submit one assembled evidence bundle for independent institution review. The review may request additional current evidence.", "parameters": { "type": "object", "properties": { "bundle_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "bundle_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "onboarding", "service": "desk_onboarding", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-onboarding", "rule_documents": [ "DESK-onboarding" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-onboarding", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_desk_account_opening": { "definition": { "name": "propose_desk_account_opening", "description": "Open an Operations Desk collection account under an available product for the stated legal entity. Opening is separate from platform acceptance.", "parameters": { "type": "object", "properties": { "profile_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "entity_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "profile_id", "entity_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "rails", "service": "desk_rails", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-rails", "rule_documents": [ "DESK-rails" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-rails", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_rail_binding": { "definition": { "name": "propose_rail_binding", "description": "Submit an explicit site, collection account and payment rail to platform validation. A saved binding is not an operational collection path.", "parameters": { "type": "object", "properties": { "site_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "rail": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "site_id", "account_id", "rail" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "rails", "service": "desk_rails", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-rails", "rule_documents": [ "DESK-rails" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-rails", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payout_validation": { "definition": { "name": "propose_payout_validation", "description": "Initiate the platform test settlement of an accepted binding. Examine the actual test receipt before relying on that path.", "parameters": { "type": "object", "properties": { "binding_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "binding_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "rails", "service": "desk_rails", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-rails", "rule_documents": [ "DESK-rails" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-rails", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_treasury_mandate": { "definition": { "name": "propose_treasury_mandate", "description": "Lodge an institution mandate from assessed signed evidence. Permissions become effective only after the recorded review.", "parameters": { "type": "object", "properties": { "mandate_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "mandate_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "treasury", "service": "desk_treasury", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-treasury", "rule_documents": [ "DESK-treasury" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-treasury", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_treasury_payment": { "definition": { "name": "propose_treasury_payment", "description": "Pay from an account under one effective institutional mandate. The executor, payer, purpose, beneficiary and amount must fit that mandate.", "parameters": { "type": "object", "properties": { "obligation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "mandate_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "executor_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "obligation_id", "account_id", "mandate_id", "executor_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "treasury", "service": "desk_treasury", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-treasury", "rule_documents": [ "DESK-treasury" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-treasury", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_card_dispute": { "definition": { "name": "propose_card_dispute", "description": "Open a card dispute with explicit loss-component amounts and assessed delivery evidence. Provisional registration does not establish final compensable loss.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "claims": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "case_id", "claims", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "disputes", "service": "desk_disputes", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-disputes", "rule_documents": [ "DESK-disputes" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-disputes", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_dispute_adjustment": { "definition": { "name": "propose_dispute_adjustment", "description": "Replace amounts of an unresolved dispute. Claims are per loss component; this does not undo refunds or settled compensation.", "parameters": { "type": "object", "properties": { "dispute_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "claims": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "dispute_id", "claims" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "disputes", "service": "desk_disputes", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-disputes", "rule_documents": [ "DESK-disputes" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-disputes", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_dispute_finalization": { "definition": { "name": "propose_dispute_finalization", "description": "Submit an unresolved dispute for final settlement at its published review time. After finalization its claim amounts cannot be changed.", "parameters": { "type": "object", "properties": { "dispute_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "dispute_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "disputes", "service": "desk_disputes", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-disputes", "rule_documents": [ "DESK-disputes" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-disputes", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_restriction_review": { "definition": { "name": "propose_restriction_review", "description": "Submit evidence to lift one specified restriction. Other restrictions and assigned receivable rights remain in force.", "parameters": { "type": "object", "properties": { "restriction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "restriction_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "restrictions", "service": "desk_restrictions", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-restrictions", "rule_documents": [ "DESK-restrictions" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-restrictions", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_receivable_release": { "definition": { "name": "propose_receivable_release", "description": "Apply assessed assignee evidence to release the specifically named receivable lots, after institution review.", "parameters": { "type": "object", "properties": { "right_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "submission_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "right_id", "submission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "restrictions", "service": "desk_restrictions", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-restrictions", "rule_documents": [ "DESK-restrictions" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-restrictions", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_purpose_payment": { "definition": { "name": "propose_purpose_payment", "description": "Pay a purpose instruction using an explicit map of eligible source-lot amounts. Different instructions can consume the same available lots over time.", "parameters": { "type": "object", "properties": { "instruction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "allocations": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "instruction_id", "allocations" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "restrictions", "service": "desk_restrictions", "portal": "operations_desk", "applicable_entity": "Operations Desk evidence edition 6.4; local economic parameters retain the Desk 5.3 contract.", "interface_document": "DESK-restrictions", "rule_documents": [ "DESK-restrictions" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-restrictions", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_service_termination": { "definition": { "name": "propose_service_termination", "description": "Terminate a subscription after its recorded notice interval. Accepted billing instances remain payable on their original account.", "parameters": { "type": "object", "properties": { "service_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "exit", "service": "desk_exit", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-exit", "rule_documents": [ "DESK-exit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-exit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_billing_migration": { "definition": { "name": "propose_billing_migration", "description": "Move future billing for one service to another open account of the same entity. Previously accepted instances keep their original account.", "parameters": { "type": "object", "properties": { "service_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "service_id", "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "exit", "service": "desk_exit", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-exit", "rule_documents": [ "DESK-exit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-exit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_account_sweep": { "definition": { "name": "propose_account_sweep", "description": "Move an explicit amount between same-entity, same-currency Desk accounts. This does not migrate accepted bills or expected returns.", "parameters": { "type": "object", "properties": { "source_account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "destination_account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "source_account_id", "destination_account_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "exit", "service": "desk_exit", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-exit", "rule_documents": [ "DESK-exit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-exit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_desk_account_close": { "definition": { "name": "propose_desk_account_close", "description": "Permanently close an open zero-balance Desk account. Closure does not cancel previously accepted obligations or redirect returns.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "exit", "service": "desk_exit", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-exit", "rule_documents": [ "DESK-exit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-exit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "inspect_multicurrency_quote": { "definition": { "name": "inspect_multicurrency_quote", "description": "Quote a specified source amount on a published currency path, including segment rounding and fee currencies. A quote does not reserve funds.", "parameters": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "route_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "source_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "account_id", "route_id", "source_minor" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "fx", "service": "desk_fx", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-fx", "rule_documents": [ "DESK-fx" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-fx", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_fx_execution": { "definition": { "name": "propose_fx_execution", "description": "Execute an unexpired exact source-amount FX quote. All source and fee currencies are debited, and the actual target amount is credited after settlement.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "fx", "service": "desk_fx", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-fx", "rule_documents": [ "DESK-fx" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-fx", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_currency_payment": { "definition": { "name": "propose_currency_payment", "description": "Deliver an explicit net amount for a currency obligation, deducting the published delivery fee from the same currency wallet.", "parameters": { "type": "object", "properties": { "obligation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "net_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "obligation_id", "account_id", "net_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "fx", "service": "desk_fx", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-fx", "rule_documents": [ "DESK-fx" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-fx", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_batch_residual_payment": { "definition": { "name": "propose_batch_residual_payment", "description": "Submit an explicit positive portion of a batch item principal with an immutable bank version and idempotency key. Aggregate supplier obligation limits remain the caller responsibility.", "parameters": { "type": "object", "properties": { "item_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "bank_version": { "type": "integer", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "submission_key": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "item_id", "bank_version", "submission_key", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "batches", "service": "desk_batches", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-batches", "rule_documents": [ "DESK-batches" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-batches", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_reserve_disbursement": { "definition": { "name": "propose_reserve_disbursement", "description": "Disburse one published reserve option after its local release conditions are met. Debit the full reserve charge, deliver the stated net amount and book any withheld fee. This does not check the customer overall funding plan.", "parameters": { "type": "object", "properties": { "route_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "route_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "collateral", "service": "desk_collateral", "portal": "operations_desk", "applicable_entity": "Operations Desk product contract edition 5.3, synthetic internal institution terms.", "interface_document": "DESK-collateral", "rule_documents": [ "DESK-collateral" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DESK-collateral", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_escrow_instruction": { "definition": { "name": "propose_escrow_instruction", "description": "Escrow acceptance, retention and distribution. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "escrow", "service": "trade_escrow", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-escrow", "rule_documents": [ "TRADE-escrow" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-escrow", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_factoring_instruction": { "definition": { "name": "propose_factoring_instruction", "description": "Invoice assignment, advance and repayment. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "factoring", "service": "trade_factoring", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-factoring", "rule_documents": [ "TRADE-factoring" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-factoring", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_documentary_credit_instruction": { "definition": { "name": "propose_documentary_credit_instruction", "description": "Documentary credit amendments and presentation. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credit_letter", "service": "trade_credit_letter", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-credit_letter", "rule_documents": [ "TRADE-credit_letter" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-credit_letter", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_guarantee_instruction": { "definition": { "name": "propose_guarantee_instruction", "description": "Guarantee issuance, release and collateral. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "guarantee", "service": "trade_guarantee", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-guarantee", "rule_documents": [ "TRADE-guarantee" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-guarantee", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_forward_instruction": { "definition": { "name": "propose_forward_instruction", "description": "Deliverable forward settlement and closeout. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "forward", "service": "trade_forward", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-forward", "rule_documents": [ "TRADE-forward" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-forward", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_direct_debit_instruction": { "definition": { "name": "propose_direct_debit_instruction", "description": "Direct debit mandate and refund administration. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "debit", "service": "trade_debit", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-debit", "rule_documents": [ "TRADE-debit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-debit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_representment_instruction": { "definition": { "name": "propose_representment_instruction", "description": "Merchant chargeback defense and concessions. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "representment", "service": "trade_representment", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-representment", "rule_documents": [ "TRADE-representment" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-representment", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_cargo_title_instruction": { "definition": { "name": "propose_cargo_title_instruction", "description": "Freight liens, cargo title and delivery orders. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "freight", "service": "trade_freight", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-freight", "rule_documents": [ "TRADE-freight" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-freight", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_reserve_cohort_instruction": { "definition": { "name": "propose_reserve_cohort_instruction", "description": "Marketplace reserve cohorts and refunds. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "rolling_reserve", "service": "trade_rolling_reserve", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-rolling_reserve", "rule_documents": [ "TRADE-rolling_reserve" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-rolling_reserve", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_netting_instruction": { "definition": { "name": "propose_netting_instruction", "description": "Multilateral novation and settlement. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "netting", "service": "trade_netting", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-netting", "rule_documents": [ "TRADE-netting" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-netting", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_collateral_instruction": { "definition": { "name": "propose_collateral_instruction", "description": "Secured facility margin and substitution. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "collateral", "service": "trade_collateral", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-collateral", "rule_documents": [ "TRADE-collateral" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-collateral", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_marine_claim_instruction": { "definition": { "name": "propose_marine_claim_instruction", "description": "Marine insurance layers and recoveries. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "insurance", "service": "trade_insurance", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-insurance", "rule_documents": [ "TRADE-insurance" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-insurance", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_term_deposit_instruction": { "definition": { "name": "propose_term_deposit_instruction", "description": "Deposit maturity, breaking and withholding. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "term_deposit", "service": "trade_term_deposit", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-term_deposit", "rule_documents": [ "TRADE-term_deposit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-term_deposit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_export_license_instruction": { "definition": { "name": "propose_export_license_instruction", "description": "Export license quantity allocation and declarations. Creates an immutable request; customer approval and execute_request perform one local action. See the applicable Trade Services contract for action values and fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_license", "service": "trade_export_license", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-export_license", "rule_documents": [ "TRADE-export_license" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-export_license", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_service_inquiry": { "definition": { "name": "propose_service_inquiry", "description": "Request an external source receipt for a service record. Creates an approved-execution request; the public receipt is delivered by a logical event. The receipt states external facts, not a recommended plan.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "case_id", "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "trade_services", "service": "trade_common", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-common", "rule_documents": [ "TRADE-common" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-common", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_service_payment": { "definition": { "name": "propose_service_payment", "description": "Pay a named service obligation using its specified wallet. Bank authorization does not certify the amount remaining under commercial documents.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "case_id", "record_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "trade_services", "service": "trade_common", "portal": "operations_desk", "applicable_entity": "Trade Services 7.0. Effective 2026-09-01. Fictional benchmark contract; service_* records only.", "interface_document": "TRADE-common", "rule_documents": [ "TRADE-common" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "TRADE-common", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payroll_attachment_instruction": { "definition": { "name": "propose_payroll_attachment_instruction", "description": "Payroll attachments. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_payroll_attachment", "service": "ext_payroll_attachment", "portal": "operations_desk", "applicable_entity": "Only payroll_attachment service cases; synthetic contract edition 8.0.", "interface_document": "EXT-payroll_attachment", "rule_documents": [ "EXT-payroll_attachment" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-payroll_attachment", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_dividend_grossup_instruction": { "definition": { "name": "propose_dividend_grossup_instruction", "description": "Dividend withholding. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_dividend_grossup", "service": "ext_dividend_grossup", "portal": "operations_desk", "applicable_entity": "Only dividend_grossup service cases; synthetic contract edition 8.0.", "interface_document": "EXT-dividend_grossup", "rule_documents": [ "EXT-dividend_grossup" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-dividend_grossup", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_collection_acceptance_instruction": { "definition": { "name": "propose_collection_acceptance_instruction", "description": "Documentary collections. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_collection_acceptance", "service": "ext_collection_acceptance", "portal": "operations_desk", "applicable_entity": "Only collection_acceptance service cases; synthetic contract edition 8.0.", "interface_document": "EXT-collection_acceptance", "rule_documents": [ "EXT-collection_acceptance" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-collection_acceptance", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_daily_windows_instruction": { "definition": { "name": "propose_daily_windows_instruction", "description": "Payment window limits. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_daily_windows", "service": "ext_daily_windows", "portal": "operations_desk", "applicable_entity": "Only daily_windows service cases; synthetic contract edition 8.0.", "interface_document": "EXT-daily_windows", "rule_documents": [ "EXT-daily_windows" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-daily_windows", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_value_date_instruction": { "definition": { "name": "propose_value_date_instruction", "description": "Value-date adjustments. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_value_date", "service": "ext_value_date", "portal": "operations_desk", "applicable_entity": "Only value_date service cases; synthetic contract edition 8.0.", "interface_document": "EXT-value_date", "rule_documents": [ "EXT-value_date" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-value_date", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_certificate_revocation_instruction": { "definition": { "name": "propose_certificate_revocation_instruction", "description": "Certificate revocations. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_certificate_revocation", "service": "ext_certificate_revocation", "portal": "operations_desk", "applicable_entity": "Only certificate_revocation service cases; synthetic contract edition 8.0.", "interface_document": "EXT-certificate_revocation", "rule_documents": [ "EXT-certificate_revocation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-certificate_revocation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_evidence_periods_instruction": { "definition": { "name": "propose_evidence_periods_instruction", "description": "Statement coverage. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_evidence_periods", "service": "ext_evidence_periods", "portal": "operations_desk", "applicable_entity": "Only evidence_periods service cases; synthetic contract edition 8.0.", "interface_document": "EXT-evidence_periods", "rule_documents": [ "EXT-evidence_periods" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-evidence_periods", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_late_presentment_instruction": { "definition": { "name": "propose_late_presentment_instruction", "description": "Late card presentments. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_late_presentment", "service": "ext_late_presentment", "portal": "operations_desk", "applicable_entity": "Only late_presentment service cases; synthetic contract edition 8.0.", "interface_document": "EXT-late_presentment", "rule_documents": [ "EXT-late_presentment" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-late_presentment", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_currency_refund_instruction": { "definition": { "name": "propose_currency_refund_instruction", "description": "Card refund currencies. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_currency_refund", "service": "ext_currency_refund", "portal": "operations_desk", "applicable_entity": "Only currency_refund service cases; synthetic contract edition 8.0.", "interface_document": "EXT-currency_refund", "rule_documents": [ "EXT-currency_refund" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-currency_refund", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_expense_classification_instruction": { "definition": { "name": "propose_expense_classification_instruction", "description": "Expense reimbursements. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_expense_classification", "service": "ext_expense_classification", "portal": "operations_desk", "applicable_entity": "Only expense_classification service cases; synthetic contract edition 8.0.", "interface_document": "EXT-expense_classification", "rule_documents": [ "EXT-expense_classification" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-expense_classification", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_successor_refund_instruction": { "definition": { "name": "propose_successor_refund_instruction", "description": "Successor refunds. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_successor_refund", "service": "ext_successor_refund", "portal": "operations_desk", "applicable_entity": "Only successor_refund service cases; synthetic contract edition 8.0.", "interface_document": "EXT-successor_refund", "rule_documents": [ "EXT-successor_refund" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-successor_refund", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_merger_eligibility_instruction": { "definition": { "name": "propose_merger_eligibility_instruction", "description": "Merger account eligibility. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_merger_eligibility", "service": "ext_merger_eligibility", "portal": "operations_desk", "applicable_entity": "Only merger_eligibility service cases; synthetic contract edition 8.0.", "interface_document": "EXT-merger_eligibility", "rule_documents": [ "EXT-merger_eligibility" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-merger_eligibility", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_dual_approval_instruction": { "definition": { "name": "propose_dual_approval_instruction", "description": "Independent signatories. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_dual_approval", "service": "ext_dual_approval", "portal": "operations_desk", "applicable_entity": "Only dual_approval service cases; synthetic contract edition 8.0.", "interface_document": "EXT-dual_approval", "rule_documents": [ "EXT-dual_approval" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-dual_approval", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_approval_tolerance_instruction": { "definition": { "name": "propose_approval_tolerance_instruction", "description": "Approval tolerance bands. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_approval_tolerance", "service": "ext_approval_tolerance", "portal": "operations_desk", "applicable_entity": "Only approval_tolerance service cases; synthetic contract edition 8.0.", "interface_document": "EXT-approval_tolerance", "rule_documents": [ "EXT-approval_tolerance" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-approval_tolerance", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_guaranteed_net_instruction": { "definition": { "name": "propose_guaranteed_net_instruction", "description": "Guaranteed net remittances. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_guaranteed_net", "service": "ext_guaranteed_net", "portal": "operations_desk", "applicable_entity": "Only guaranteed_net service cases; synthetic contract edition 8.0.", "interface_document": "EXT-guaranteed_net", "rule_documents": [ "EXT-guaranteed_net" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-guaranteed_net", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_billing_plan_instruction": { "definition": { "name": "propose_billing_plan_instruction", "description": "Service billing plans. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_billing_plan", "service": "ext_billing_plan", "portal": "operations_desk", "applicable_entity": "Only billing_plan service cases; synthetic contract edition 8.0.", "interface_document": "EXT-billing_plan", "rule_documents": [ "EXT-billing_plan" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-billing_plan", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_data_scope_instruction": { "definition": { "name": "propose_data_scope_instruction", "description": "Marketplace data scopes. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_data_scope", "service": "ext_data_scope", "portal": "operations_desk", "applicable_entity": "Only data_scope service cases; synthetic contract edition 8.0.", "interface_document": "EXT-data_scope", "rule_documents": [ "EXT-data_scope" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-data_scope", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_demurrage_instruction": { "definition": { "name": "propose_demurrage_instruction", "description": "Container appointments. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_demurrage", "service": "ext_demurrage", "portal": "operations_desk", "applicable_entity": "Only demurrage service cases; synthetic contract edition 8.0.", "interface_document": "EXT-demurrage", "rule_documents": [ "EXT-demurrage" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-demurrage", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_early_discount_instruction": { "definition": { "name": "propose_early_discount_instruction", "description": "Early payment discounts. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_early_discount", "service": "ext_early_discount", "portal": "operations_desk", "applicable_entity": "Only early_discount service cases; synthetic contract edition 8.0.", "interface_document": "EXT-early_discount", "rule_documents": [ "EXT-early_discount" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-early_discount", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_interest_prepayment_instruction": { "definition": { "name": "propose_interest_prepayment_instruction", "description": "Loan prepayment allocation. Prepare one local action, subject to customer approval and bank execution. The service policy states the supported actions and their fields.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "ext_interest_prepayment", "service": "ext_interest_prepayment", "portal": "operations_desk", "applicable_entity": "Only interest_prepayment service cases; synthetic contract edition 8.0.", "interface_document": "EXT-interest_prepayment", "rule_documents": [ "EXT-interest_prepayment" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "EXT-interest_prepayment", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_collection_investigation": { "definition": { "name": "propose_collection_investigation", "description": "Duplicate collection investigation and mandate control. Prepares one local instruction; see the product document for action fields and effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_diagnostic_debit", "service": "diverse_diagnostic_debit", "portal": "operations_desk", "applicable_entity": "Service case kind: diagnostic_debit", "interface_document": "DIVERSE-diagnostic_debit", "rule_documents": [ "DIVERSE-diagnostic_debit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-diagnostic_debit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_corporate_entitlement": { "definition": { "name": "propose_corporate_entitlement", "description": "Corporate succession, refund rights and account continuity. Prepares one local instruction; see the product document for action fields and effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_succession_refund", "service": "diverse_succession_refund", "portal": "operations_desk", "applicable_entity": "Service case kind: succession_refund", "interface_document": "DIVERSE-succession_refund", "rule_documents": [ "DIVERSE-succession_refund" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-succession_refund", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_collateral_reallocation": { "definition": { "name": "propose_collateral_reallocation", "description": "Security substitution and loan repayment. Prepares one local instruction; see the product document for action fields and effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_collateral_portfolio", "service": "diverse_collateral_portfolio", "portal": "operations_desk", "applicable_entity": "Service case kind: collateral_portfolio", "interface_document": "DIVERSE-collateral_portfolio", "rule_documents": [ "DIVERSE-collateral_portfolio" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-collateral_portfolio", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_insurance_recovery": { "definition": { "name": "propose_insurance_recovery", "description": "Layered cargo recovery and replacement payments. Prepares one local instruction; see the product document for action fields and effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_layered_recovery", "service": "diverse_layered_recovery", "portal": "operations_desk", "applicable_entity": "Service case kind: layered_recovery", "interface_document": "DIVERSE-layered_recovery", "rule_documents": [ "DIVERSE-layered_recovery" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-layered_recovery", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_ledger_recovery": { "definition": { "name": "propose_ledger_recovery", "description": "Interrupted sales ledger imports and settlement reconciliation. Prepares one local instruction; see the product document for action fields and effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_ledger_resume", "service": "diverse_ledger_resume", "portal": "operations_desk", "applicable_entity": "Service case kind: ledger_resume", "interface_document": "DIVERSE-ledger_resume", "rule_documents": [ "DIVERSE-ledger_resume" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-ledger_resume", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_deposit_calendar": { "definition": { "name": "propose_deposit_calendar", "description": "Prepare a full early term-deposit redemption or a registered operating obligation payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_tiered_deposit_calendar", "service": "diverse_tiered_deposit_calendar", "portal": "operations_desk", "applicable_entity": "tiered_deposit_calendar contracts.", "interface_document": "DIVERSE-tiered_deposit_calendar", "rule_documents": [ "DIVERSE-tiered_deposit_calendar" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-tiered_deposit_calendar", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_net_remittance": { "definition": { "name": "propose_net_remittance", "description": "Guaranteed remittance and residual obligation settlement. Prepares one local instruction; see the product document for action fields and effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_net_recourse", "service": "diverse_net_recourse", "portal": "operations_desk", "applicable_entity": "Service case kind: net_recourse", "interface_document": "DIVERSE-net_recourse", "rule_documents": [ "DIVERSE-net_recourse" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-net_recourse", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_invoice_discounting": { "definition": { "name": "propose_invoice_discounting", "description": "Invoice discount settlement and credit notes. Prepares one local instruction; see the product document for action fields and effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_discount_portfolio", "service": "diverse_discount_portfolio", "portal": "operations_desk", "applicable_entity": "Service case kind: discount_portfolio", "interface_document": "DIVERSE-discount_portfolio", "rule_documents": [ "DIVERSE-discount_portfolio" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-discount_portfolio", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_programme_draw": { "definition": { "name": "propose_programme_draw", "description": "Prepare one draw from an existing cash arrangement to a named service wallet. Read the arrangement and route terms. Requires customer approval; does not complete the underlying service.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "route_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "destination_case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "terms_version": { "type": "integer", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "order_id", "route_id", "destination_case_id", "amount_minor", "terms_version" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "programme_funding", "service": "programme_funding", "portal": "operations_desk", "applicable_entity": "Customer cash arrangements supporting linked service activities", "interface_document": "PROGRAMME-funding", "rule_documents": [ "PROGRAMME-funding" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "PROGRAMME-funding", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_dated_collateral": { "definition": { "name": "propose_dated_collateral", "description": "Prepare a repayment, collateral pledge or release, or a supplier payment under the dated collateral contract. Read the product terms and actual custody status.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_dated_collateral", "service": "diverse_dated_collateral", "portal": "operations_desk", "applicable_entity": "Service case kind: dated_collateral. Dated collateral contracts; USD corporate lending. Effective at service minute 0.", "interface_document": "DIVERSE-dated_collateral", "rule_documents": [ "DIVERSE-dated_collateral" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-dated_collateral", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_entitlement_resolution": { "definition": { "name": "propose_entitlement_resolution", "description": "Prepare a successor account application, account closure or an invoice-linked refund. Confirm entitlement, account status and actual payment window.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_inherited_entitlements", "service": "diverse_inherited_entitlements", "portal": "operations_desk", "applicable_entity": "inherited_entitlements service contracts; registered corporate instruments and existing collection mandates.", "interface_document": "DIVERSE-inherited_entitlements", "rule_documents": [ "DIVERSE-inherited_entitlements" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-inherited_entitlements", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_expense_reconciliation": { "definition": { "name": "propose_expense_reconciliation", "description": "Prepare an actual staff reimbursement or advance recovery under the expense contract.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_reconciled_expenses", "service": "diverse_reconciled_expenses", "portal": "operations_desk", "applicable_entity": "reconciled_expenses service cases; USD staff reimbursements and existing recovery mandates.", "interface_document": "DIVERSE-reconciled_expenses", "rule_documents": [ "DIVERSE-reconciled_expenses" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-reconciled_expenses", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_debit_reconciliation": { "definition": { "name": "propose_debit_reconciliation", "description": "Prepare a debit return, mandate revocation, collection recall or direct invoice payment under the reconciliation contract.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_reconciled_debits", "service": "diverse_reconciled_debits", "portal": "operations_desk", "applicable_entity": "reconciled_debits contracts; bank entries, accepted instructions and collection windows.", "interface_document": "DIVERSE-reconciled_debits", "rule_documents": [ "DIVERSE-reconciled_debits" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-reconciled_debits", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_certificate_remediation": { "definition": { "name": "propose_certificate_remediation", "description": "Prepare certificate issuance, evidence-file reopening, resubmission or authority rebinding under the evidence contract.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_temporal_certificates", "service": "diverse_temporal_certificates", "portal": "operations_desk", "applicable_entity": "temporal_certificates contracts; partner reliance and continuing authorities.", "interface_document": "DIVERSE-temporal_certificates", "rule_documents": [ "DIVERSE-temporal_certificates" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-temporal_certificates", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_indemnity_reconciliation": { "definition": { "name": "propose_indemnity_reconciliation", "description": "Prepare an insurer advance or return, salvage realization, replacement payment or loss-recovery record.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_shared_indemnity", "service": "diverse_shared_indemnity", "portal": "operations_desk", "applicable_entity": "shared_indemnity contracts; existing policy claims and replacement invoices.", "interface_document": "DIVERSE-shared_indemnity", "rule_documents": [ "DIVERSE-shared_indemnity" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-shared_indemnity", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_subscription_election": { "definition": { "name": "propose_subscription_election", "description": "Prepare a future subscription election, partner-voucher reservation or account closure under the consolidated billing contract.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_prospective_billing", "service": "diverse_prospective_billing", "portal": "operations_desk", "applicable_entity": "prospective_billing contracts; forward plan elections, shared group qualification and partner vouchers.", "interface_document": "DIVERSE-prospective_billing", "rule_documents": [ "DIVERSE-prospective_billing" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-prospective_billing", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payroll_remittance": { "definition": { "name": "propose_payroll_remittance", "description": "Prepare an employee, payroll-tax or attachment-creditor remittance against a recorded wage obligation.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_dated_payroll", "service": "diverse_dated_payroll", "portal": "operations_desk", "applicable_entity": "dated_payroll contracts; synthetic payroll service terms, not any jurisdiction's actual law.", "interface_document": "DIVERSE-dated_payroll", "rule_documents": [ "DIVERSE-dated_payroll" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-dated_payroll", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_sales_recovery": { "definition": { "name": "propose_sales_recovery", "description": "Prepare a stream permission or import, receivable assignment or unwind, settlement withdrawal or supplier payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_reconciled_sync", "service": "diverse_reconciled_sync", "portal": "operations_desk", "applicable_entity": "reconciled_sync contracts; posted source events, invoice assignments and settlement withdrawals.", "interface_document": "DIVERSE-reconciled_sync", "rule_documents": [ "DIVERSE-reconciled_sync" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-reconciled_sync", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_corporate_payment": { "definition": { "name": "propose_corporate_payment", "description": "Record genuine company signature copies or execute an owner-approved supplier payment under its corporate control mandate.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_versioned_authority", "service": "diverse_versioned_authority", "portal": "operations_desk", "applicable_entity": "versioned_authority contracts; customer corporate controls, natural-person independence and payment amendments.", "interface_document": "DIVERSE-versioned_authority", "rule_documents": [ "DIVERSE-versioned_authority" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-versioned_authority", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_forward_delivery": { "definition": { "name": "propose_forward_delivery", "description": "Prepare a currency delivery, remaining forward closeout, spot exchange or supplier remittance.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_contingent_forwards", "service": "diverse_contingent_forwards", "portal": "operations_desk", "applicable_entity": "contingent_forwards contracts; actual delivery, remaining obligations and multi-currency wallets.", "interface_document": "DIVERSE-contingent_forwards", "rule_documents": [ "DIVERSE-contingent_forwards" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-contingent_forwards", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_escrow_settlement": { "definition": { "name": "propose_escrow_settlement", "description": "Prepare a lot-funded distribution, buyer refund or return of an actual prior distribution.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_inspection_escrow", "service": "diverse_inspection_escrow", "portal": "operations_desk", "applicable_entity": "inspection_escrow contracts; final inspections, assigned receivables, warranty holdings and buyer-source refunds.", "interface_document": "DIVERSE-inspection_escrow", "rule_documents": [ "DIVERSE-inspection_escrow" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-inspection_escrow", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_licensed_shipment": { "definition": { "name": "propose_licensed_shipment", "description": "Prepare an actual shipment declaration using one eligible quantity permit.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_source_bound_licenses", "service": "diverse_source_bound_licenses", "portal": "operations_desk", "applicable_entity": "source_bound_licenses services; exporter, material, destination and dated quantity permissions.", "interface_document": "DIVERSE-source_bound_licenses", "rule_documents": [ "DIVERSE-source_bound_licenses" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-source_bound_licenses", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_documentary_import": { "definition": { "name": "propose_documentary_import", "description": "Prepare a supplier payment, drawing recall or settlement, delivery guarantee, original-title lodgement or actual cargo delivery.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_documentary_imports", "service": "diverse_documentary_imports", "portal": "operations_desk", "applicable_entity": "documentary_imports services: supplier balances, accepted drawings, original titles and delivery guarantees.", "interface_document": "DIVERSE-documentary_imports", "rule_documents": [ "DIVERSE-documentary_imports" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-documentary_imports", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_cargo_handling": { "definition": { "name": "propose_cargo_handling", "description": "Prepare an actual whole-lot dispatch in a current handling window to a registered customer or supplier facility.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_inspected_handling", "service": "diverse_inspected_handling", "portal": "operations_desk", "applicable_entity": "inspected_handling services: released equipment, quality inspection, customer delivery and supplier returns.", "interface_document": "DIVERSE-inspected_handling", "rule_documents": [ "DIVERSE-inspected_handling" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-inspected_handling", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_account_consolidation": { "definition": { "name": "propose_account_consolidation", "description": "Prepare a registered product-continuity application, pending service nomination or account closure.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_corporate_consolidation", "service": "diverse_corporate_consolidation", "portal": "operations_desk", "applicable_entity": "corporate_consolidation services: group companies, inherited products, merchant mandates and scheduled account reviews.", "interface_document": "DIVERSE-corporate_consolidation", "rule_documents": [ "DIVERSE-corporate_consolidation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-corporate_consolidation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_factoring_settlement": { "definition": { "name": "propose_factoring_settlement", "description": "Prepare an invoice-finance assignment, local obligation payment, net remittance or overadvance repayment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_priority_factoring", "service": "diverse_priority_factoring", "portal": "operations_desk", "applicable_entity": "priority_factoring services: whole-claim financing, registered senior facilities and supplier payments.", "interface_document": "DIVERSE-priority_factoring", "rule_documents": [ "DIVERSE-priority_factoring" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-priority_factoring", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_group_clearing": { "definition": { "name": "propose_group_clearing", "description": "Prepare or refresh an intercompany clearing instruction, arrange registered staff signatures or execute a captured settlement.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_revised_netting", "service": "diverse_revised_netting", "portal": "operations_desk", "applicable_entity": "revised_netting service cases; USD group-company clearing.", "interface_document": "DIVERSE-revised_netting", "rule_documents": [ "DIVERSE-revised_netting" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-revised_netting", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_interest_correction": { "definition": { "name": "propose_interest_correction", "description": "Prepare an economic-date amendment, signed current-period interest adjustment or registered accountant payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_dated_interest", "service": "diverse_dated_interest", "portal": "operations_desk", "applicable_entity": "dated_interest service cases; USD debit-interest facilities with historical statements.", "interface_document": "DIVERSE-dated_interest", "rule_documents": [ "DIVERSE-dated_interest" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-dated_interest", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_card_reconciliation": { "definition": { "name": "propose_card_reconciliation", "description": "Prepare a physical corporate-card dispute or a registered card payment after reconciling final merchant evidence and actual credits.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_late_card_reconciliation", "service": "diverse_late_card_reconciliation", "portal": "operations_desk", "applicable_entity": "late_card_reconciliation service cases; USD corporate cards.", "interface_document": "DIVERSE-late_card_reconciliation", "rule_documents": [ "DIVERSE-late_card_reconciliation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-late_card_reconciliation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_effective_distribution": { "definition": { "name": "propose_effective_distribution", "description": "Prepare a net corporate distribution or withholding remittance after determining the beneficial owner's effective tax evidence.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_effective_distributions", "service": "diverse_effective_distributions", "portal": "operations_desk", "applicable_entity": "effective_distributions service cases; corporate USD distributions.", "interface_document": "DIVERSE-effective_distributions", "rule_documents": [ "DIVERSE-effective_distributions" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-effective_distributions", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_title_release": { "definition": { "name": "propose_title_release", "description": "Prepare a title split activation, document endorsement or cargo dispatch under the release contract.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_document_title_allocation", "service": "diverse_document_title_allocation", "portal": "operations_desk", "applicable_entity": "document_title_allocation services for titled cargo release.", "interface_document": "DIVERSE-document_title_allocation", "rule_documents": [ "DIVERSE-document_title_allocation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-document_title_allocation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_discounted_payables": { "definition": { "name": "propose_discounted_payables", "description": "Prepare a current invoice settlement or stock pickup under a supplier credit account.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_dated_discount_credit", "service": "diverse_dated_discount_credit", "portal": "operations_desk", "applicable_entity": "dated_discount_credit services for commercial payables and stock orders.", "interface_document": "DIVERSE-dated_discount_credit", "rule_documents": [ "DIVERSE-dated_discount_credit" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-dated_discount_credit", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_merchant_remedy": { "definition": { "name": "propose_merchant_remedy", "description": "Prepare a purchase-linked merchant refund or an accepted network dispute response.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_overlapping_remedies", "service": "diverse_overlapping_remedies", "portal": "operations_desk", "applicable_entity": "overlapping_remedies merchant disputes.", "interface_document": "DIVERSE-overlapping_remedies", "rule_documents": [ "DIVERSE-overlapping_remedies" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-overlapping_remedies", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_actual_collection": { "definition": { "name": "propose_actual_collection", "description": "Prepare a bill-finance sale, registered payable payment or original collection-document movement.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_actual_collections", "service": "diverse_actual_collections", "portal": "operations_desk", "applicable_entity": "actual_collections export collections", "interface_document": "DIVERSE-actual_collections", "rule_documents": [ "DIVERSE-actual_collections" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-actual_collections", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_loan_prepayment": { "definition": { "name": "propose_loan_prepayment", "description": "Prepare a principal repayment against a registered loan under its current repayment window and processing terms.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_reset_prepayments", "service": "diverse_reset_prepayments", "portal": "operations_desk", "applicable_entity": "reset_prepayments service for a dated loan portfolio.", "interface_document": "DIVERSE-reset_prepayments", "rule_documents": [ "DIVERSE-reset_prepayments" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-reset_prepayments", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_guarantee_continuity": { "definition": { "name": "propose_guarantee_continuity", "description": "Prepare a guarantee renewal, temporary cover, cash margin adjustment or registered supplier payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_continuous_guarantees", "service": "diverse_continuous_guarantees", "portal": "operations_desk", "applicable_entity": "continuous_guarantees contracts.", "interface_document": "DIVERSE-continuous_guarantees", "rule_documents": [ "DIVERSE-continuous_guarantees" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-continuous_guarantees", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_origin_refund": { "definition": { "name": "propose_origin_refund", "description": "Prepare a purchase-linked refund in a supported currency or a live wallet exchange.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_origin_currency_refunds", "service": "diverse_origin_currency_refunds", "portal": "operations_desk", "applicable_entity": "origin_currency_refunds service cases.", "interface_document": "DIVERSE-origin_currency_refunds", "rule_documents": [ "DIVERSE-origin_currency_refunds" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-origin_currency_refunds", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_tolerance_payment": { "definition": { "name": "propose_tolerance_payment", "description": "Prepare a corporate payment under the current quote and two independent cumulative authorities.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_revised_tolerances", "service": "diverse_revised_tolerances", "portal": "operations_desk", "applicable_entity": "revised_tolerances equipment payment batches", "interface_document": "DIVERSE-revised_tolerances", "rule_documents": [ "DIVERSE-revised_tolerances" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-revised_tolerances", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_windowed_payment": { "definition": { "name": "propose_windowed_payment", "description": "Prepare a supplier remittance within the current legal-counterparty and global payment window.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_windowed_payment_recovery", "service": "diverse_windowed_payment_recovery", "portal": "operations_desk", "applicable_entity": "windowed_payment_recovery commercial remittances.", "interface_document": "DIVERSE-windowed_payment_recovery", "rule_documents": [ "DIVERSE-windowed_payment_recovery" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-windowed_payment_recovery", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_period_indemnity": { "definition": { "name": "propose_period_indemnity", "description": "Prepare an equipment indemnity compromise or a registered replacement payment using the actual ownership and incident records.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_period_coverage", "service": "diverse_period_coverage", "portal": "operations_desk", "applicable_entity": "period_coverage equipment indemnity accounts", "interface_document": "DIVERSE-period_coverage", "rule_documents": [ "DIVERSE-period_coverage" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-period_coverage", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_net_delivery": { "definition": { "name": "propose_net_delivery", "description": "Prepare a protected or standard supplier remittance, or an exact-net top-up after the actual intermediary result.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_contingent_net", "service": "diverse_contingent_net", "portal": "operations_desk", "applicable_entity": "contingent_net supplier-remittance matters", "interface_document": "DIVERSE-contingent_net", "rule_documents": [ "DIVERSE-contingent_net" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-contingent_net", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_reserve_settlement": { "definition": { "name": "propose_reserve_settlement", "description": "Prepare a source-bound customer refund, future refund reservation, ordinary-tranche acceleration, logistics payment or operating-bank payout.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_maturing_refund_reserves", "service": "diverse_maturing_refund_reserves", "portal": "operations_desk", "applicable_entity": "maturing_refund_reserves contracts.", "interface_document": "DIVERSE-maturing_refund_reserves", "rule_documents": [ "DIVERSE-maturing_refund_reserves" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-maturing_refund_reserves", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_custody_coupon": { "definition": { "name": "propose_custody_coupon", "description": "Prepare a manufactured-coupon election, coupon advance, bond settlement, investor coupon transfer, authorized excess recovery, or guarantor collateral application and return.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_custody_coupon_entitlements", "service": "diverse_custody_coupon_entitlements", "portal": "operations_desk", "applicable_entity": "custody_coupon_entitlements", "interface_document": "DIVERSE-custody_coupon_entitlements", "rule_documents": [ "DIVERSE-custody_coupon_entitlements" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-custody_coupon_entitlements", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_custody_election": { "definition": { "name": "propose_custody_election", "description": "Prepare an elective exchange tender, old-share delivery, invoice payment, bonus-right redemption or subscription, or a class-specific block or odd-lot market trade.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_custody_elective_allocation", "service": "diverse_custody_elective_allocation", "portal": "operations_desk", "applicable_entity": "custody_elective_allocation", "interface_document": "DIVERSE-custody_elective_allocation", "rule_documents": [ "DIVERSE-custody_elective_allocation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-custody_elective_allocation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_custody_ndf": { "definition": { "name": "propose_custody_ndf", "description": "Prepare a bond pledge, release or delivery, segregated margin movement, financing transaction or agreement-specific NDF settlement.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_custody_ndf_segregation", "service": "diverse_custody_ndf_segregation", "portal": "operations_desk", "applicable_entity": "custody_ndf_segregation", "interface_document": "DIVERSE-custody_ndf_segregation", "rule_documents": [ "DIVERSE-custody_ndf_segregation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-custody_ndf_segregation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_bonded_drawback": { "definition": { "name": "propose_bonded_drawback", "description": "Prepare an authorized instruction under the bonded_drawback service contract. Read its public records and complete SOP.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_bonded_drawback", "service": "diverse_bonded_drawback", "portal": "operations_desk", "applicable_entity": "bonded_drawback specialist services.", "interface_document": "DIVERSE-bonded_drawback", "rule_documents": [ "DIVERSE-bonded_drawback" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-bonded_drawback", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_missing_original_loi": { "definition": { "name": "propose_missing_original_loi", "description": "Prepare an authorized instruction under the missing_original_loi service contract. Read its public records and complete SOP.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_missing_original_loi", "service": "diverse_missing_original_loi", "portal": "operations_desk", "applicable_entity": "missing_original_loi specialist services.", "interface_document": "DIVERSE-missing_original_loi", "rule_documents": [ "DIVERSE-missing_original_loi" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-missing_original_loi", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_incoterm_claim_settlement": { "definition": { "name": "propose_incoterm_claim_settlement", "description": "Prepare an authorized instruction under the incoterm_claim_settlement service contract. Read its public records and complete SOP.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_incoterm_claim_settlement", "service": "diverse_incoterm_claim_settlement", "portal": "operations_desk", "applicable_entity": "incoterm_claim_settlement specialist services.", "interface_document": "DIVERSE-incoterm_claim_settlement", "rule_documents": [ "DIVERSE-incoterm_claim_settlement" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-incoterm_claim_settlement", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_temporary_admission_excise": { "definition": { "name": "propose_temporary_admission_excise", "description": "Prepare an authorized instruction under the temporary_admission_excise service contract. Read its public records and complete SOP.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_temporary_admission_excise", "service": "diverse_temporary_admission_excise", "portal": "operations_desk", "applicable_entity": "temporary_admission_excise specialist services.", "interface_document": "DIVERSE-temporary_admission_excise", "rule_documents": [ "DIVERSE-temporary_admission_excise" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-temporary_admission_excise", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_finance_jv": { "definition": { "name": "propose_finance_jv", "description": "Prepare a member rescue contribution, source-specific bridge return, creditor novation, residual debt assignment or project payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_jv_default_equalization", "service": "diverse_jv_default_equalization", "portal": "operations_desk", "applicable_entity": "jv_default_equalization", "interface_document": "DIVERSE-jv_default_equalization", "rule_documents": [ "DIVERSE-jv_default_equalization" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-jv_default_equalization", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_finance_syndicated": { "definition": { "name": "propose_finance_syndicated", "description": "Prepare transfer support or accelerated consent settlement, a lender-specific machinery draw contribution, actual delivery payment, or separate final principal and period-fee distribution.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_syndicated_transfer_allocation", "service": "diverse_syndicated_transfer_allocation", "portal": "operations_desk", "applicable_entity": "syndicated_transfer_allocation", "interface_document": "DIVERSE-syndicated_transfer_allocation", "rule_documents": [ "DIVERSE-syndicated_transfer_allocation" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-syndicated_transfer_allocation", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_finance_borrowing": { "definition": { "name": "propose_finance_borrowing", "description": "Prepare a facility draw or repayment, legacy retirement, receivable sale, debtor-source collection application or release, supplier credit application, or inventory payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_borrowing_base_retirement", "service": "diverse_borrowing_base_retirement", "portal": "operations_desk", "applicable_entity": "borrowing_base_retirement", "interface_document": "DIVERSE-borrowing_base_retirement", "rule_documents": [ "DIVERSE-borrowing_base_retirement" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-borrowing_base_retirement", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_platform_campaign": { "definition": { "name": "propose_platform_campaign", "description": "Prepare a campaign routing election, creative payment, sponsor award, actual agency cash adjustment, sponsor remittance or merchant owner contribution.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_platform_campaign_cofunding", "service": "diverse_platform_campaign_cofunding", "portal": "operations_desk", "applicable_entity": "platform_campaign_cofunding", "interface_document": "DIVERSE-platform_campaign_cofunding", "rule_documents": [ "DIVERSE-platform_campaign_cofunding" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-platform_campaign_cofunding", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_platform_transfer": { "definition": { "name": "propose_platform_transfer", "description": "Prepare a legacy fulfillment source, legal stock transfer, obligation-specific customer credit novation, replacement delivery or actual seller/consignor commission settlement.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_platform_seller_transfer", "service": "diverse_platform_seller_transfer", "portal": "operations_desk", "applicable_entity": "platform_seller_transfer", "interface_document": "DIVERSE-platform_seller_transfer", "rule_documents": [ "DIVERSE-platform_seller_transfer" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-platform_seller_transfer", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_platform_tradein": { "definition": { "name": "propose_platform_tradein", "description": "Prepare intact collection, serial retirement or return, certificate-backed stock release, model-specific order fulfillment or household trade-in benefit payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_platform_tradein_replacement", "service": "diverse_platform_tradein_replacement", "portal": "operations_desk", "applicable_entity": "platform_tradein_replacement", "interface_document": "DIVERSE-platform_tradein_replacement", "rule_documents": [ "DIVERSE-platform_tradein_replacement" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-platform_tradein_replacement", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_credential_cutover": { "definition": { "name": "propose_credential_cutover", "description": "Prepare a scoped sender fence, finite-capacity credential activation, original-payment retry, capacity-limited standard or paid priority supplier remittance, or production cutover.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_credential_ack_cutover", "service": "diverse_credential_ack_cutover", "portal": "operations_desk", "applicable_entity": "credential_ack_cutover synthetic local contract", "interface_document": "DIVERSE-credential_ack_cutover", "rule_documents": [ "DIVERSE-credential_ack_cutover" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-credential_ack_cutover", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_traced_fraud_recall": { "definition": { "name": "propose_traced_fraud_recall", "description": "Prepare a mixed-account freeze, instant or deferred original-edge fraud return, final settlement election or legitimate supplier payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_traced_fraud_restitution", "service": "diverse_traced_fraud_restitution", "portal": "operations_desk", "applicable_entity": "traced_fraud_restitution synthetic local contract", "interface_document": "DIVERSE-traced_fraud_restitution", "rule_documents": [ "DIVERSE-traced_fraud_restitution" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-traced_fraud_restitution", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_claim_retention": { "definition": { "name": "propose_claim_retention", "description": "Prepare a original-evidence secured advance, collateral substitution, repayment, claim settlement, evidence export, claim submission, original deletion or replacement-goods payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_claim_field_retention", "service": "diverse_claim_field_retention", "portal": "operations_desk", "applicable_entity": "claim_field_retention synthetic local contract", "interface_document": "DIVERSE-claim_field_retention", "rule_documents": [ "DIVERSE-claim_field_retention" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-claim_field_retention", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_pvp_queue": { "definition": { "name": "propose_pvp_queue", "description": "Prepare a queued currency settlement, a gross release, a registered funding ticket, a term placement or a supplier remittance.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_queued_pvp_liquidity", "service": "diverse_queued_pvp_liquidity", "portal": "operations_desk", "applicable_entity": "queued_pvp_liquidity settlement services", "interface_document": "DIVERSE-queued_pvp_liquidity", "rule_documents": [ "DIVERSE-queued_pvp_liquidity" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-queued_pvp_liquidity", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_default_waterfall": { "definition": { "name": "propose_default_waterfall", "description": "Prepare an actual member loss contribution, collateral-source election, emergency-liquidity draw or repayment, surviving settlement payment or estate-certificate use.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_participant_default_waterfall", "service": "diverse_participant_default_waterfall", "portal": "operations_desk", "applicable_entity": "participant_default_waterfall settlement services", "interface_document": "DIVERSE-participant_default_waterfall", "rule_documents": [ "DIVERSE-participant_default_waterfall" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-participant_default_waterfall", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_documentary_assignment": { "definition": { "name": "propose_documentary_assignment", "description": "Prepare a documentary proceeds assignment, performance transfer, presentation, revocation or actual debt payment.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_documentary_proceeds_priority", "service": "diverse_documentary_proceeds_priority", "portal": "operations_desk", "applicable_entity": "documentary_proceeds_priority settlement services", "interface_document": "DIVERSE-documentary_proceeds_priority", "rule_documents": [ "DIVERSE-documentary_proceeds_priority" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-documentary_proceeds_priority", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_beneficial_restitution": { "definition": { "name": "propose_beneficial_restitution", "description": "Prepare an actual source-bound sweep reversal, authorized bilateral loan, owned supplier or bank-debt remittance, or a buyer-deposit return.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "diverse_beneficial_sweep_restitution", "service": "diverse_beneficial_sweep_restitution", "portal": "operations_desk", "applicable_entity": "beneficial_sweep_restitution settlement services", "interface_document": "DIVERSE-beneficial_sweep_restitution", "rule_documents": [ "DIVERSE-beneficial_sweep_restitution" ], "schema_source": "frozen executable catalog and canonical business-service manual", "rule_id": "DIVERSE-beneficial_sweep_restitution", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_split_capture": { "definition": { "name": "propose_payment_split_capture", "description": "Prepare an owner-approved split capture instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_split_capture", "service": "payment_payment_split_capture", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_split_capture", "interface_document": "PAYMENT-payment_split_capture", "rule_documents": [ "PAYMENT-payment_split_capture" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_authentication_binding": { "definition": { "name": "propose_payment_authentication_binding", "description": "Prepare an owner-approved authentication binding instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_authentication_binding", "service": "payment_payment_authentication_binding", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_authentication_binding", "interface_document": "PAYMENT-payment_authentication_binding", "rule_documents": [ "PAYMENT-payment_authentication_binding" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_marketplace_split_refund": { "definition": { "name": "propose_payment_marketplace_split_refund", "description": "Prepare an owner-approved marketplace split refund instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_marketplace_split_refund", "service": "payment_payment_marketplace_split_refund", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_marketplace_split_refund", "interface_document": "PAYMENT-payment_marketplace_split_refund", "rule_documents": [ "PAYMENT-payment_marketplace_split_refund" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_stored_value_restitution": { "definition": { "name": "propose_payment_stored_value_restitution", "description": "Prepare an owner-approved stored value restitution instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_stored_value_restitution", "service": "payment_payment_stored_value_restitution", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_stored_value_restitution", "interface_document": "PAYMENT-payment_stored_value_restitution", "rule_documents": [ "PAYMENT-payment_stored_value_restitution" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_acquirer_batch_close": { "definition": { "name": "propose_payment_acquirer_batch_close", "description": "Prepare an owner-approved acquirer batch close instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_acquirer_batch_close", "service": "payment_payment_acquirer_batch_close", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_acquirer_batch_close", "interface_document": "PAYMENT-payment_acquirer_batch_close", "rule_documents": [ "PAYMENT-payment_acquirer_batch_close" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_subscription_proration": { "definition": { "name": "propose_payment_subscription_proration", "description": "Prepare an owner-approved subscription proration instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_subscription_proration", "service": "payment_payment_subscription_proration", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_subscription_proration", "interface_document": "PAYMENT-payment_subscription_proration", "rule_documents": [ "PAYMENT-payment_subscription_proration" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_cross_calendar_delivery": { "definition": { "name": "propose_payment_cross_calendar_delivery", "description": "Prepare an owner-approved cross calendar delivery instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_cross_calendar_delivery", "service": "payment_payment_cross_calendar_delivery", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_cross_calendar_delivery", "interface_document": "PAYMENT-payment_cross_calendar_delivery", "rule_documents": [ "PAYMENT-payment_cross_calendar_delivery" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_installment_return": { "definition": { "name": "propose_payment_installment_return", "description": "Prepare an owner-approved installment return instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_installment_return", "service": "payment_payment_installment_return", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_installment_return", "interface_document": "PAYMENT-payment_installment_return", "rule_documents": [ "PAYMENT-payment_installment_return" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_group_purchase_commitment": { "definition": { "name": "propose_payment_group_purchase_commitment", "description": "Prepare an owner-approved group purchase commitment instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_group_purchase_commitment", "service": "payment_payment_group_purchase_commitment", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_group_purchase_commitment", "interface_document": "PAYMENT-payment_group_purchase_commitment", "rule_documents": [ "PAYMENT-payment_group_purchase_commitment" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_payment_cheque_stop_and_replacement": { "definition": { "name": "propose_payment_cheque_stop_and_replacement", "description": "Prepare an owner-approved cheque stop and replacement instruction. Applicable contract documents define individual actions and their local effects.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "data": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "case_id", "action", "data" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_payment_cheque_stop_and_replacement", "service": "payment_payment_cheque_stop_and_replacement", "portal": "operations_desk", "applicable_entity": "Payment service supplement payment_cheque_stop_and_replacement", "interface_document": "PAYMENT-payment_cheque_stop_and_replacement", "rule_documents": [ "PAYMENT-payment_cheque_stop_and_replacement" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "propose_joint_capital_delivery": { "definition": { "name": "propose_joint_capital_delivery", "description": "Prepare delivery of registered service capital from customer-owned settlement allocations. Read the cash allocation agreement and the current route terms. Funding does not pay a bill.", "parameters": { "type": "object", "properties": { "agreement_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "case_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "route_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "allocations": { "type": "object", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "terms_version": { "type": "integer", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "agreement_id", "case_id", "route_id", "allocations", "terms_version" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "joint_cash_delivery", "service": "joint_cash_delivery", "portal": "operations_desk", "applicable_entity": "Customer-owned settlement allocations; joint_agreements; original business and Payment operating cash", "interface_document": "JOINT-CASH-delivery", "rule_documents": [ "JOINT-CASH-delivery" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "operations_desk", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "operations_desk" }, "a_pay_business_invoice": { "definition": { "name": "a_pay_business_invoice", "description": "Send an irrevocable bank payment against an invoice. The bank checks cash, recipient availability and account-scoped idempotency, not whether the customer's commercial obligation permits another payment.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Invoice record ID." }, "recipient_id": { "type": "string", "description": "Bank recipient record ID." }, "amount_minor": { "type": "integer", "description": "Positive integer amount in the invoice currency's minor units." }, "payment_key": { "type": "string", "description": "Account-scoped immutable business idempotency key." }, "purpose": { "type": "string", "description": "Truthful commercial purpose label.", "default": "COMMERCIAL" } }, "required": [ "invoice_id", "recipient_id", "amount_minor", "payment_key" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "accidental_transfer_refunds_and_ordinary_supply_cash", "service": "px_a_r_return_working_cash", "portal": "psp", "applicable_entity": "Buyer duplicate-transfer handling with a concurrent original supply obligation.", "interface_document": "PX-A-R-RETURN-WORKING-CASH", "rule_documents": [ "PX-A-R-RETURN-WORKING-CASH" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_submit_source_chain": { "definition": { "name": "a_submit_source_chain", "description": "Submit actual uploaded shop, PSP and remitter evidence for review. Submission does not release funds; an independent bank result may accept only some orders.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Pending incoming payment ID." }, "order_ids": { "type": "array", "description": "Sales order IDs covered by this evidence chain.", "items": { "type": "string" } } }, "required": [ "incoming_id", "order_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "incoming_psp_funds", "service": "px_a_source", "portal": "psp", "applicable_entity": "Incoming PSP funds", "interface_document": "PX-A-SOURCE", "rule_documents": [ "PX-A-SOURCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_claim_incoming_orders": { "definition": { "name": "a_claim_incoming_orders", "description": "Credit only bank-accepted and submitted orders from a PSP incoming payment. Each order can be credited once; rejected or unreviewed orders remain quarantined.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Incoming payment ID." }, "order_ids": { "type": "array", "description": "Distinct accepted sales order IDs to release.", "items": { "type": "string" } } }, "required": [ "incoming_id", "order_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "incoming_psp_funds", "service": "px_a_source", "portal": "psp", "applicable_entity": "Incoming PSP funds", "interface_document": "PX-A-SOURCE", "rule_documents": [ "PX-A-SOURCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_select_stock_order": { "definition": { "name": "a_select_stock_order", "description": "Choose a supplier's currently offered stock package. Selection fixes the invoice quantity and price; subsequent payment must match the selected offer.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Stock invoice ID." }, "offer_id": { "type": "string", "description": "Supplier package offer ID." } }, "required": [ "invoice_id", "offer_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "incoming_psp_funds", "service": "px_a_source", "portal": "psp", "applicable_entity": "Incoming PSP funds", "interface_document": "PX-A-SOURCE", "rule_documents": [ "PX-A-SOURCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_open_bank_trace": { "definition": { "name": "a_open_bank_trace", "description": "Buy a formal bank trace for a missing incoming transfer. Fees are nonrefundable. Sender-bank and receiving-bank traces have different responsibility scopes; the environment publishes the actual finding.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Missing incoming payment ID." }, "channel_id": { "type": "string", "description": "Trace channel and fee record ID." } }, "required": [ "incoming_id", "channel_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "missing_incoming_transfers", "service": "px_a_trace", "portal": "psp", "applicable_entity": "Missing incoming transfers", "interface_document": "PX-A-TRACE", "rule_documents": [ "PX-A-TRACE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_amend_transfer_instruction": { "definition": { "name": "a_amend_transfer_instruction", "description": "Submit the missing address or purpose instruction to the responsible intermediary after a trace locates the payment. The published amendment fee is charged and the original transfer is released once.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Located incoming transfer ID." }, "responsible_bank": { "type": "string", "description": "Bank named in the trace result." }, "instruction": { "type": "string", "description": "Complete corrected instruction from the customer evidence." } }, "required": [ "incoming_id", "responsible_bank", "instruction" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "missing_incoming_transfers", "service": "px_a_trace", "portal": "psp", "applicable_entity": "Missing incoming transfers", "interface_document": "PX-A-TRACE", "rule_documents": [ "PX-A-TRACE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_recall_incoming_transfer": { "definition": { "name": "a_recall_incoming_transfer", "description": "Request irrevocable return of a held transfer to its original sender. This is a lawful alternative to correcting the transfer, but it does not credit the recipient.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Held incoming transfer ID." } }, "required": [ "incoming_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "missing_incoming_transfers", "service": "px_a_trace", "portal": "psp", "applicable_entity": "Missing incoming transfers", "interface_document": "PX-A-TRACE", "rule_documents": [ "PX-A-TRACE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_investigate_incoming_owner": { "definition": { "name": "a_investigate_incoming_owner", "description": "Register an ownership investigation using an original remittance proof. Knowing an amount or sending an email does not establish ownership. The bank result is an independent environment event.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Quarantined incoming payment ID." } }, "required": [ "incoming_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "quarantined_or_recalled_incoming_payments", "service": "px_a_owner", "portal": "psp", "applicable_entity": "Quarantined or recalled incoming payments", "interface_document": "PX-A-OWNER", "rule_documents": [ "PX-A-OWNER" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_dispose_incoming_balance": { "definition": { "name": "a_dispose_incoming_balance", "description": "Return quarantined funds along their original bank route or claim funds supported by a published ownership decision. Funds cannot be sent to a claimant's substitute account through this tool.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Incoming payment ID." }, "disposition": { "type": "string", "description": "RETURN_ORIGIN or CLAIM." }, "decision_version": { "type": "integer", "description": "Exact currently published bank decision version." } }, "required": [ "incoming_id", "disposition", "decision_version" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "quarantined_or_recalled_incoming_payments", "service": "px_a_owner", "portal": "psp", "applicable_entity": "Quarantined or recalled incoming payments", "interface_document": "PX-A-OWNER", "rule_documents": [ "PX-A-OWNER" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_submit_receipt_claim": { "definition": { "name": "a_submit_receipt_claim", "description": "Register a claim while a sender recall is under review. Submission is not an ownership decision and does not cancel the parallel recall.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Incoming payment involved in a recall." }, "position": { "type": "string", "description": "RETAIN or CONSENT_RETURN." } }, "required": [ "incoming_id", "position" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "quarantined_or_recalled_incoming_payments", "service": "px_a_owner", "portal": "psp", "applicable_entity": "Quarantined or recalled incoming payments", "interface_document": "PX-A-OWNER", "rule_documents": [ "PX-A-OWNER" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_ingest_credit_notice": { "definition": { "name": "a_ingest_credit_notice", "description": "Project a credit notice using the immutable bank transaction ID. Replayed deliveries of the same bank transaction do not create a second credit; distinct bank transactions do.", "parameters": { "type": "object", "properties": { "notice_id": { "type": "string", "description": "Notification delivery ID." } }, "required": [ "notice_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "duplicate_credit_notifications", "service": "px_a_notices", "portal": "psp", "applicable_entity": "Duplicate credit notifications", "interface_document": "PX-A-NOTICES", "rule_documents": [ "PX-A-NOTICES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_archive_credit_notice": { "definition": { "name": "a_archive_credit_notice", "description": "Archive a notification without booking it. Archiving is irreversible for this operations window and should only be used when another processed notice represents the same bank transaction.", "parameters": { "type": "object", "properties": { "notice_id": { "type": "string", "description": "Notification delivery ID." }, "reason": { "type": "string", "description": "Operator's reason for archiving." } }, "required": [ "notice_id", "reason" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "duplicate_credit_notifications", "service": "px_a_notices", "portal": "psp", "applicable_entity": "Duplicate credit notifications", "interface_document": "PX-A-NOTICES", "rule_documents": [ "PX-A-NOTICES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_return_duplicate_transfer": { "definition": { "name": "a_return_duplicate_transfer", "description": "Return a real credited bank transfer to the original sender. Identical notification amounts do not establish that a bank transfer was economically duplicated.", "parameters": { "type": "object", "properties": { "bank_transaction_id": { "type": "string", "description": "Actual bank transaction ID to return." } }, "required": [ "bank_transaction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "accidental_transfer_refunds_and_ordinary_supply_cash", "service": "px_a_r_return_working_cash", "portal": "psp", "applicable_entity": "Buyer duplicate-transfer handling with a concurrent original supply obligation.", "interface_document": "PX-A-R-RETURN-WORKING-CASH", "rule_documents": [ "PX-A-R-RETURN-WORKING-CASH" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_assign_virtual_receipt": { "definition": { "name": "a_assign_virtual_receipt", "description": "Assign a late receipt to a shop using an explicit historical lease and timestamp basis. SEND and ARRIVAL are operationally supported bases; the customer's contract determines the applicable basis. Assignment can be corrected until shop payout.", "parameters": { "type": "object", "properties": { "receipt_id": { "type": "string", "description": "Late virtual-account receipt ID." }, "lease_id": { "type": "string", "description": "Historical virtual-account lease ID." }, "timestamp_basis": { "type": "string", "description": "SEND or ARRIVAL." } }, "required": [ "receipt_id", "lease_id", "timestamp_basis" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "late_receipts_on_reused_virtual_accounts", "service": "px_a_lease", "portal": "psp", "applicable_entity": "Late receipts on reused virtual accounts", "interface_document": "PX-A-LEASE", "rule_documents": [ "PX-A-LEASE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_pay_out_shop_receipt": { "definition": { "name": "a_pay_out_shop_receipt", "description": "Pay an assigned receipt to the selected shop. Payout is irrevocable; later timestamp corrections cannot move cash already sent to a different shop.", "parameters": { "type": "object", "properties": { "receipt_id": { "type": "string", "description": "Assigned virtual-account receipt ID." } }, "required": [ "receipt_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "receivable_portfolio_collection_mandates", "service": "px_a_r_portfolio_mandates", "portal": "psp", "applicable_entity": "Original delayed receipts and separately retained portfolio claims.", "interface_document": "PX-A-R-PORTFOLIO-MANDATES", "rule_documents": [ "PX-A-R-PORTFOLIO-MANDATES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_resubmit_payment_intent": { "definition": { "name": "a_resubmit_payment_intent", "description": "Resubmit an uncertain payment with a business key. Reusing its original key returns the existing attempt. A fresh key creates a distinct irrevocable payment, even when another key later settles the same invoice.", "parameters": { "type": "object", "properties": { "intent_id": { "type": "string", "description": "Uncertain business payment intent ID." }, "payment_key": { "type": "string", "description": "Original or new account-scoped business key." } }, "required": [ "intent_id", "payment_key" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "timed_out_payment_intents", "service": "px_a_retry", "portal": "psp", "applicable_entity": "Timed-out payment intents", "interface_document": "PX-A-RETRY", "rule_documents": [ "PX-A-RETRY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_abandon_timeout_screen": { "definition": { "name": "a_abandon_timeout_screen", "description": "Dismiss a timed-out payment from the user interface. This changes only the screen state; a bank request already sent can still settle.", "parameters": { "type": "object", "properties": { "intent_id": { "type": "string", "description": "Timed-out intent ID." } }, "required": [ "intent_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "timed_out_payment_intents", "service": "px_a_retry", "portal": "psp", "applicable_entity": "Timed-out payment intents", "interface_document": "PX-A-RETRY", "rule_documents": [ "PX-A-RETRY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_preview_payment_file": { "definition": { "name": "a_preview_payment_file", "description": "Parse an uploaded payment export with explicit monetary-unit and fee semantics. Returns line-level proposed bank amounts and original obligation references without moving money. MAJOR_NET converts decimal major units to minor units and adds sender fees; MINOR_NET treats values as minor units; MAJOR_GROSS subtracts recipient-borne fees.", "parameters": { "type": "object", "properties": { "file_record_id": { "type": "string", "description": "Public export metadata ID with uploaded file contents." }, "schema": { "type": "string", "description": "MAJOR_NET, MINOR_NET, or MAJOR_GROSS." } }, "required": [ "file_record_id", "schema" ], "additionalProperties": false }, "read_only": true, "approval_required": false, "business_area": "legacy_batch_payment_exports", "service": "px_a_file", "portal": "psp", "applicable_entity": "Legacy batch payment exports", "interface_document": "PX-A-FILE", "rule_documents": [ "PX-A-FILE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_execute_payment_file_line": { "definition": { "name": "a_execute_payment_file_line", "description": "Execute a reviewed payment-file line. The original obligation reference survives beneficiary repair. A rejected line charges its stated rejection fee; a successful line cannot be paid again using the same obligation key. Operator-selected parsing semantics are honored by the bank.", "parameters": { "type": "object", "properties": { "file_record_id": { "type": "string", "description": "Uploaded payment export metadata ID." }, "line_id": { "type": "string", "description": "Line ID within the export." }, "schema": { "type": "string", "description": "MAJOR_NET, MINOR_NET, or MAJOR_GROSS." }, "recipient_id": { "type": "string", "description": "Current bank recipient ID." }, "payment_key": { "type": "string", "description": "Idempotency key retaining the original obligation reference." } }, "required": [ "file_record_id", "line_id", "schema", "recipient_id", "payment_key" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_file_acceptance_and_beneficiary_availability", "service": "px_a_r_file_availability", "portal": "psp", "applicable_entity": "Customer-contracted bank application windows or original file availability services.", "interface_document": "PX-A-R-FILE-AVAILABILITY", "rule_documents": [ "PX-A-R-FILE-AVAILABILITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_project_bank_receipts": { "definition": { "name": "a_project_bank_receipts", "description": "Recompute payment status from received bank events. CAUSAL selects the greatest bank sequence and respects a RETURNED correction of SETTLED. ARRIVAL selects the most recently delivered message and is available for legacy projections; delivery order is not causal order.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Payment obligation ID." }, "projection": { "type": "string", "description": "CAUSAL or ARRIVAL." } }, "required": [ "invoice_id", "projection" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "out_of_order_payment_receipts", "service": "px_a_receipts", "portal": "psp", "applicable_entity": "Out-of-order payment receipts", "interface_document": "PX-A-RECEIPTS", "rule_documents": [ "PX-A-RECEIPTS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_confirm_recipient_entity": { "definition": { "name": "a_confirm_recipient_entity", "description": "Record entity verification using actual uploaded contractual identity evidence and the bank's published holder/alias result. Verification does not itself pay the recipient.", "parameters": { "type": "object", "properties": { "recipient_id": { "type": "string", "description": "Candidate recipient bank account ID." }, "invoice_id": { "type": "string", "description": "Commercial invoice ID." } }, "required": [ "recipient_id", "invoice_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "same_name_corporate_suppliers", "service": "px_a_entity", "portal": "psp", "applicable_entity": "Same-name corporate suppliers", "interface_document": "PX-A-ENTITY", "rule_documents": [ "PX-A-ENTITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_declare_contract_payment": { "definition": { "name": "a_declare_contract_payment", "description": "Declare selected contract components and a purpose to a supported route. The banking route accepts its supported declared purposes; the customer remains responsible for truthful component classification. Published review acceptance can be partial.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Composite commercial contract ID." }, "component_ids": { "type": "array", "description": "Contract component IDs.", "items": { "type": "string" } }, "route_id": { "type": "string", "description": "Purpose-capable payment route ID." }, "declared_purpose": { "type": "string", "description": "GOODS, LICENSE, SERVICE, or MIXED." } }, "required": [ "contract_id", "component_ids", "route_id", "declared_purpose" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "goods_licensing_and_services_in_one_contract", "service": "px_a_purpose", "portal": "psp", "applicable_entity": "Goods, licensing and services in one contract", "interface_document": "PX-A-PURPOSE", "rule_documents": [ "PX-A-PURPOSE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_execute_contract_declaration": { "definition": { "name": "a_execute_contract_declaration", "description": "Pay the accepted components of a reviewed declaration and charge its route fee once. Components not accepted remain unpaid; a supplemental declaration can cover them later.", "parameters": { "type": "object", "properties": { "declaration_id": { "type": "string", "description": "Reviewed declaration ID." } }, "required": [ "declaration_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "goods_licensing_and_services_in_one_contract", "service": "px_a_purpose", "portal": "psp", "applicable_entity": "Goods, licensing and services in one contract", "interface_document": "PX-A-PURPOSE", "rule_documents": [ "PX-A-PURPOSE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reserve_equipment_offer": { "definition": { "name": "a_reserve_equipment_offer", "description": "Buy a nonrefundable reservation for one equipment offer. Reservation does not guarantee compatibility with other components. A merchant stock event may invalidate an offer; reservation fees remain charged.", "parameters": { "type": "object", "properties": { "offer_id": { "type": "string", "description": "Equipment supplier offer ID." } }, "required": [ "offer_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "all_or_none_equipment_purchases", "service": "px_a_bundle", "portal": "psp", "applicable_entity": "All-or-none equipment purchases", "interface_document": "PX-A-BUNDLE", "rule_documents": [ "PX-A-BUNDLE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_release_equipment_reservation": { "definition": { "name": "a_release_equipment_reservation", "description": "Release an equipment reservation. Its booking fee is nonrefundable; no equipment principal is paid.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "Held reservation ID." } }, "required": [ "reservation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "all_or_none_equipment_purchases", "service": "px_a_bundle", "portal": "psp", "applicable_entity": "All-or-none equipment purchases", "interface_document": "PX-A-BUNDLE", "rule_documents": [ "PX-A-BUNDLE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_commit_equipment_bundle": { "definition": { "name": "a_commit_equipment_bundle", "description": "Atomically buy a complete compatible set of reserved equipment. Every required component, current stock and reservation must be valid before any principal is debited.", "parameters": { "type": "object", "properties": { "reservation_ids": { "type": "array", "description": "Distinct held reservation IDs for one complete set.", "items": { "type": "string" } }, "contract_id": { "type": "string", "description": "Equipment purchase contract ID." } }, "required": [ "reservation_ids", "contract_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "all_or_none_equipment_purchases", "service": "px_a_bundle", "portal": "psp", "applicable_entity": "All-or-none equipment purchases", "interface_document": "PX-A-BUNDLE", "rule_documents": [ "PX-A-BUNDLE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_buy_equipment_individually": { "definition": { "name": "a_buy_equipment_individually", "description": "Buy an available equipment component immediately without a complete-set commitment. This legitimate retail purchase is irrevocable and may violate an all-or-none procurement condition.", "parameters": { "type": "object", "properties": { "offer_id": { "type": "string", "description": "Equipment offer ID." } }, "required": [ "offer_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "all_or_none_equipment_purchases", "service": "px_a_bundle", "portal": "psp", "applicable_entity": "All-or-none equipment purchases", "interface_document": "PX-A-BUNDLE", "rule_documents": [ "PX-A-BUNDLE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_register_debit_mandate": { "definition": { "name": "a_register_debit_mandate", "description": "Register a replacement debit mandate from an actual debtor-signed upload. A revoked mandate is never reactivated by a balance top-up.", "parameters": { "type": "object", "properties": { "debt_id": { "type": "string", "description": "Debt requiring a new mandate." }, "mandate_reference": { "type": "string", "description": "Mandate reference appearing in the debtor-signed evidence." } }, "required": [ "debt_id", "mandate_reference" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "debtor_collections", "service": "px_a_debit", "portal": "psp", "applicable_entity": "Debtor collections", "interface_document": "PX-A-DEBIT", "rule_documents": [ "PX-A-DEBIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_retry_direct_debit": { "definition": { "name": "a_retry_direct_debit", "description": "Retry a returned direct debit under the synthetic network rules. NSF has a finite retry count and each attempted retry can consume it; REVOKED requires a replacement mandate; TECHNICAL retains the original retry key. Successful repeated keys deduplicate.", "parameters": { "type": "object", "properties": { "debt_id": { "type": "string", "description": "Returned debt ID." }, "retry_key": { "type": "string", "description": "Network retry idempotency key." } }, "required": [ "debt_id", "retry_key" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "debtor_collections", "service": "px_a_debit", "portal": "psp", "applicable_entity": "Debtor collections", "interface_document": "PX-A-DEBIT", "rule_documents": [ "PX-A-DEBIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_waive_debt": { "definition": { "name": "a_waive_debt", "description": "Irrevocably waive an unpaid commercial debt. Waiving is a legitimate customer choice but does not constitute collection.", "parameters": { "type": "object", "properties": { "debt_id": { "type": "string", "description": "Debt ID." } }, "required": [ "debt_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "debtor_collections", "service": "px_a_debit", "portal": "psp", "applicable_entity": "Debtor collections", "interface_document": "PX-A-DEBIT", "rule_documents": [ "PX-A-DEBIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reserve_cash_pickup": { "definition": { "name": "a_reserve_cash_pickup", "description": "Reserve cash at an agent for a wallet withdrawal or direct remittance. Reservation consumes local cash capacity and charges the nonrefundable agent fee. The beneficiary identity and reservation expiry are binding.", "parameters": { "type": "object", "properties": { "agent_id": { "type": "string", "description": "Cash agent ID." }, "beneficiary_id": { "type": "string", "description": "Cash recipient ID." }, "amount_minor": { "type": "integer", "description": "Positive cash amount in destination currency minor units." }, "mode": { "type": "string", "description": "WALLET or DIRECT." } }, "required": [ "agent_id", "beneficiary_id", "amount_minor", "mode" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cross_border_recipient_cash_access", "service": "px_a_cash", "portal": "psp", "applicable_entity": "Cross-border recipient cash access", "interface_document": "PX-A-CASH", "rule_documents": [ "PX-A-CASH" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_fund_mobile_wallet": { "definition": { "name": "a_fund_mobile_wallet", "description": "Transfer money irrevocably into a mobile wallet within its current balance limit. Wallet receipt is digital value and is not evidence that physical cash was delivered.", "parameters": { "type": "object", "properties": { "wallet_id": { "type": "string", "description": "Mobile wallet ID." }, "amount_minor": { "type": "integer", "description": "Positive amount in wallet-currency minor units." } }, "required": [ "wallet_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cross_border_recipient_cash_access", "service": "px_a_cash", "portal": "psp", "applicable_entity": "Cross-border recipient cash access", "interface_document": "PX-A-CASH", "rule_documents": [ "PX-A-CASH" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_deliver_reserved_cash": { "definition": { "name": "a_deliver_reserved_cash", "description": "Complete a reserved cash handover and issue its physical-delivery receipt. Wallet mode debits the matching beneficiary's wallet; direct mode debits the remitter's bank account. An expired reservation cannot deliver cash.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "Cash reservation ID." }, "wallet_id": { "type": "string", "description": "Wallet ID for WALLET; empty string for DIRECT." } }, "required": [ "reservation_id", "wallet_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cross_border_recipient_cash_access", "service": "px_a_cash", "portal": "psp", "applicable_entity": "Cross-border recipient cash access", "interface_document": "PX-A-CASH", "rule_documents": [ "PX-A-CASH" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_snapshot_accepted_orders": { "definition": { "name": "a_snapshot_accepted_orders", "description": "Obtain an immutable servicing snapshot of already accepted marketplace orders before changing an exclusive payment binding. A snapshot preserves those accepted obligations when the old authorization is removed.", "parameters": { "type": "object", "properties": { "binding_id": { "type": "string", "description": "Existing marketplace payment binding ID." } }, "required": [ "binding_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "marketplace_payment_binding_changes", "service": "px_a_bind", "portal": "psp", "applicable_entity": "Marketplace payment binding changes", "interface_document": "PX-A-BIND", "rule_documents": [ "PX-A-BIND" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_remove_marketplace_binding": { "definition": { "name": "a_remove_marketplace_binding", "description": "Remove an exclusive marketplace binding. PRESERVE retains snapshotted accepted orders; CANCEL cancels those accepted orders. New binding does not automatically recreate canceled commercial orders.", "parameters": { "type": "object", "properties": { "binding_id": { "type": "string", "description": "Old exclusive binding ID." }, "accepted_order_policy": { "type": "string", "description": "PRESERVE or CANCEL." } }, "required": [ "binding_id", "accepted_order_policy" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "marketplace_payment_binding_changes", "service": "px_a_bind", "portal": "psp", "applicable_entity": "Marketplace payment binding changes", "interface_document": "PX-A-BIND", "rule_documents": [ "PX-A-BIND" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_bind_marketplace_account": { "definition": { "name": "a_bind_marketplace_account", "description": "Bind an authenticated marketplace account after removing its exclusive predecessor. Enterprise accounts require enterprise certification plus a verified linked HarborPay identity; personal accounts require a verified personal HarborPay identity.", "parameters": { "type": "object", "properties": { "market_account_id": { "type": "string", "description": "Marketplace customer account ID." }, "provider": { "type": "string", "description": "Payment provider name." } }, "required": [ "market_account_id", "provider" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "marketplace_payment_binding_changes", "service": "px_a_bind", "portal": "psp", "applicable_entity": "Marketplace payment binding changes", "interface_document": "PX-A-BIND", "rule_documents": [ "PX-A-BIND" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_pay_marketplace_order": { "definition": { "name": "a_pay_marketplace_order", "description": "Pay an unpaid marketplace order with an active binding for that exact authenticated account. Accepted orders continue only through their original servicing snapshot; paying their commercial invoice separately risks duplication.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Marketplace order ID." }, "binding_id": { "type": "string", "description": "Active or preserved servicing binding ID." } }, "required": [ "order_id", "binding_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "marketplace_payment_binding_changes", "service": "px_a_bind", "portal": "psp", "applicable_entity": "Marketplace payment binding changes", "interface_document": "PX-A-BIND", "rule_documents": [ "PX-A-BIND" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_quote_procurement_basket": { "definition": { "name": "a_quote_procurement_basket", "description": "Calculate and freeze a quote for selected orders. Basket coupons depend on minimum eligible subtotal and payment method; red packets are restricted to WALLET. Quotes bind each order revision and cannot be paid after merchant changes.", "parameters": { "type": "object", "properties": { "order_ids": { "type": "array", "description": "Distinct unpaid order IDs in this checkout.", "items": { "type": "string" } }, "method": { "type": "string", "description": "CROSSBORDER, WALLET or MERCHANT_BUNDLE." }, "benefit_id": { "type": "string", "description": "Coupon or red-packet ID, or empty string for no benefit." }, "delivery": { "type": "string", "description": "STANDARD or EXPRESS." } }, "required": [ "order_ids", "method", "benefit_id", "delivery" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "multi_order_procurement", "service": "px_a_basket", "portal": "psp", "applicable_entity": "Multi-order procurement", "interface_document": "PX-A-BASKET", "rule_documents": [ "PX-A-BASKET" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_pay_procurement_quote": { "definition": { "name": "a_pay_procurement_quote", "description": "Pay an unchanged frozen procurement quote and consume its applicable benefit. The bank does not enforce the customer's total-budget preference across multiple checkouts.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "Frozen procurement quote ID." } }, "required": [ "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "multi_order_procurement", "service": "px_a_basket", "portal": "psp", "applicable_entity": "Multi-order procurement", "interface_document": "PX-A-BASKET", "rule_documents": [ "PX-A-BASKET" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_submit_invoice_authority": { "definition": { "name": "a_submit_invoice_authority", "description": "Submit a genuine signed payment instruction for bank approval of its scope, version and limit. The stated nonrefundable submission fee is charged. A later bank decision can narrow the requested capacity or beneficiary scope.", "parameters": { "type": "object", "properties": { "scope_id": { "type": "string", "description": "Commercial payment-authority scope ID." }, "instruction_id": { "type": "string", "description": "Signed instruction candidate ID." } }, "required": [ "scope_id", "instruction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "signed_invoice_payment_authority", "service": "px_a_authority", "portal": "psp", "applicable_entity": "Invoices, historical shop payouts and enterprise orders with authority_scope_id", "interface_document": "PX-A-AUTHORITY", "rule_documents": [ "PX-A-AUTHORITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reserve_invoice_authority": { "definition": { "name": "a_reserve_invoice_authority", "description": "Reserve part of an approved authorization for its named commercial scope. The reservation locks that authorization capacity until used, canceled or expired; its fee is nonrefundable. A bank-legal reservation can leave too little capacity for another obligation.", "parameters": { "type": "object", "properties": { "authorization_id": { "type": "string", "description": "Approved authorization ID." }, "amount_minor": { "type": "integer", "description": "Positive authorized-capacity amount in USD minor units." }, "allocation": { "type": "string", "description": "INVOICE or DISCRETIONARY use of the reserved capacity." } }, "required": [ "authorization_id", "amount_minor", "allocation" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "signed_invoice_payment_authority", "service": "px_a_authority", "portal": "psp", "applicable_entity": "Invoices, historical shop payouts and enterprise orders with authority_scope_id", "interface_document": "PX-A-AUTHORITY", "rule_documents": [ "PX-A-AUTHORITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_cancel_authority_reservation": { "definition": { "name": "a_cancel_authority_reservation", "description": "Release an unused payment-authority capacity reservation. Booking fees are not refunded; consumed payment authority cannot be undone.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "Held authorization-capacity reservation ID." } }, "required": [ "reservation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_authority_reservation_cancellation", "service": "iface_authority_reservation", "portal": "psp", "applicable_entity": "PSP product accounts; Cancellation of unused payment-authority reservations without creating a payment.", "interface_document": "IFACE-AUTHORITY-RESERVATION", "rule_documents": [ "IFACE-AUTHORITY-RESERVATION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_bind_invoice_instruction": { "definition": { "name": "a_bind_invoice_instruction", "description": "Bind a held invoice-capacity reservation to an approved beneficiary instruction. This establishes the beneficiary mapping used by subsequent bank payments, but does not itself pay an invoice. The approved invoice scope and recipient mapping are preserved in the binding.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "Held INVOICE authority reservation ID." }, "beneficiary_id": { "type": "string", "description": "Approved beneficiary identifier; a shop ID or recipient instruction ID depending on the scope." } }, "required": [ "reservation_id", "beneficiary_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "signed_invoice_payment_authority", "service": "px_a_authority", "portal": "psp", "applicable_entity": "Invoices, historical shop payouts and enterprise orders with authority_scope_id", "interface_document": "PX-A-AUTHORITY", "rule_documents": [ "PX-A-AUTHORITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_beneficiary_allocation": { "definition": { "name": "a_request_beneficiary_allocation", "description": "Ask the receiving bank or merchant to identify the received value and its commercial allocation. The request is tied to an actual settled source; it is not another payment. The fixed response can disclose deductions, wrong-account allocations or unavailable value.", "parameters": { "type": "object", "properties": { "settlement_id": { "type": "string", "description": "Beneficiary settlement-application case ID." } }, "required": [ "settlement_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "beneficiary_settlement_application", "service": "px_a_application", "portal": "psp", "applicable_entity": "Settled transfers needing final commercial application", "interface_document": "PX-A-APPLICATION", "rule_documents": [ "PX-A-APPLICATION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reassign_beneficiary_credit": { "definition": { "name": "a_reassign_beneficiary_credit", "description": "Move unapplied beneficiary value between the published commercial accounts. Reassignment is an irrevocable allocation instruction and charges the published fee; moving money to another valid account can leave the intended invoice unpaid.", "parameters": { "type": "object", "properties": { "settlement_id": { "type": "string", "description": "Reviewed beneficiary settlement case ID." }, "destination_account": { "type": "string", "description": "One of the published beneficiary commercial-account references." }, "amount_minor": { "type": "integer", "description": "Positive unapplied value to reassign in minor units." } }, "required": [ "settlement_id", "destination_account", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "beneficiary_settlement_application", "service": "px_a_application", "portal": "psp", "applicable_entity": "Settled transfers needing final commercial application", "interface_document": "PX-A-APPLICATION", "rule_documents": [ "PX-A-APPLICATION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_resolve_beneficiary_deduction": { "definition": { "name": "a_resolve_beneficiary_deduction", "description": "Resolve an observed deduction using an eligible bank reimbursement or a sender-funded fee top-up. A bank reimbursement may be directed to the beneficiary or refunded to the sender, consuming it once. All fee top-ups debit real cash.", "parameters": { "type": "object", "properties": { "settlement_id": { "type": "string", "description": "Reviewed beneficiary settlement case ID." }, "method": { "type": "string", "description": "BANK_TO_BENEFICIARY, BANK_TO_SENDER, or SENDER_TOPUP." }, "amount_minor": { "type": "integer", "description": "Deduction value being resolved in minor units." } }, "required": [ "settlement_id", "method", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "beneficiary_settlement_application", "service": "px_a_application", "portal": "psp", "applicable_entity": "Settled transfers needing final commercial application", "interface_document": "PX-A-APPLICATION", "rule_documents": [ "PX-A-APPLICATION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_apply_beneficiary_invoice": { "definition": { "name": "a_apply_beneficiary_invoice", "description": "Apply allocated beneficiary value to a published receivable. This consumes value once and creates the merchant or receiving-bank application receipt; a settled sending-bank payment alone is not this commercial receipt.", "parameters": { "type": "object", "properties": { "settlement_id": { "type": "string", "description": "Reviewed settlement case ID." }, "commercial_account": { "type": "string", "description": "Beneficiary account from which allocated value will be applied." }, "receivable_id": { "type": "string", "description": "Published beneficiary receivable ID." }, "amount_minor": { "type": "integer", "description": "Positive receivable amount in minor units." } }, "required": [ "settlement_id", "commercial_account", "receivable_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "beneficiary_application_capacity_and_value_dates", "service": "px_a_r_application_windows", "portal": "psp", "applicable_entity": "Customer-contracted bank application windows or original file availability services.", "interface_document": "PX-A-R-APPLICATION-WINDOWS", "rule_documents": [ "PX-A-R-APPLICATION-WINDOWS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_book_supplier_dispatch": { "definition": { "name": "a_book_supplier_dispatch", "description": "Book a paid purchase into a supplier dispatch route. The route fixes product compatibility, nonrefundable transport cost and delivery window. The supplier later publishes actual allocated units and eligible shortfall refund value.", "parameters": { "type": "object", "properties": { "delivery_id": { "type": "string", "description": "Paid purchase fulfillment record ID." }, "transport_id": { "type": "string", "description": "Published supplier transport route ID." } }, "required": [ "delivery_id", "transport_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_fulfillment_replacement", "service": "px_a_fulfillment", "portal": "psp", "applicable_entity": "Paid stock packages, compatible equipment sets and multi-order purchases", "interface_document": "PX-A-FULFILLMENT", "rule_documents": [ "PX-A-FULFILLMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_claim_supplier_shortfall": { "definition": { "name": "a_claim_supplier_shortfall", "description": "Claim the supplier-confirmed undelivered value. CASH restores spendable bank funds; STORE_CREDIT creates restricted replacement credit accepted only by matching supplier offers. This is a one-time disposition of the actual published shortfall.", "parameters": { "type": "object", "properties": { "delivery_id": { "type": "string", "description": "Fulfillment record with a published supplier shortfall." }, "disposition": { "type": "string", "description": "CASH or STORE_CREDIT." } }, "required": [ "delivery_id", "disposition" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_fulfillment_replacement", "service": "px_a_fulfillment", "portal": "psp", "applicable_entity": "Paid stock packages, compatible equipment sets and multi-order purchases", "interface_document": "PX-A-FULFILLMENT", "rule_documents": [ "PX-A-FULFILLMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_order_replacement_units": { "definition": { "name": "a_order_replacement_units", "description": "Purchase replacement units under a published offer. Compatibility, available quantity, expiry and accepted refund-credit type are public. A technically valid replacement can be incompatible with the customer's original purchase.", "parameters": { "type": "object", "properties": { "delivery_id": { "type": "string", "description": "Fulfillment record with remaining undelivered units." }, "offer_id": { "type": "string", "description": "Replacement supply offer ID." }, "quantity": { "type": "integer", "description": "Positive integer replacement-unit quantity." }, "funding": { "type": "string", "description": "CASH or STORE_CREDIT." } }, "required": [ "delivery_id", "offer_id", "quantity", "funding" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "replacement_component_certificates_and_complete_set_usability", "service": "px_a_r_equipment_certificates", "portal": "psp", "applicable_entity": "Original atomic equipment purchases with replacement commissioning requirements.", "interface_document": "PX-A-R-EQUIPMENT-CERTIFICATES", "rule_documents": [ "PX-A-R-EQUIPMENT-CERTIFICATES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_accept_supplier_delivery": { "definition": { "name": "a_accept_supplier_delivery", "description": "Record actual delivered original and replacement units against the commercial purchase. The receiving service reports their quantity and compatibility; it does not waive the customer's required specification or budget.", "parameters": { "type": "object", "properties": { "delivery_id": { "type": "string", "description": "Supplier fulfillment record ID." }, "replacement_order_ids": { "type": "array", "description": "Distinct actually delivered replacement-order IDs; empty when original supply was complete.", "items": { "type": "string" } } }, "required": [ "delivery_id", "replacement_order_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "replacement_component_certificates_and_complete_set_usability", "service": "px_a_r_equipment_certificates", "portal": "psp", "applicable_entity": "Original atomic equipment purchases with replacement commissioning requirements.", "interface_document": "PX-A-R-EQUIPMENT-CERTIFICATES", "rule_documents": [ "PX-A-R-EQUIPMENT-CERTIFICATES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_route_capacity_review": { "definition": { "name": "a_request_route_capacity_review", "description": "Request bank review of shared payment-route capacity. The published requested limit is provisional; the bank event returns the actual approved amount and validity. Review does not pay any contract component.", "parameters": { "type": "object", "properties": { "capacity_id": { "type": "string", "description": "Shared route-capacity record ID." } }, "required": [ "capacity_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "commercial_contract_settlement", "service": "px_a_route_capacity", "portal": "psp", "applicable_entity": "Purpose routes carrying a capacity_id", "interface_document": "PX-A-ROUTE-CAPACITY", "rule_documents": [ "PX-A-ROUTE-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_select_collection_clearing": { "definition": { "name": "a_select_collection_clearing", "description": "Select a clearing service for one returned debit before resubmission. The successful debit first becomes a held receivable. Its service determines actual cash release time and the nonrefundable clearing charge.", "parameters": { "type": "object", "properties": { "debt_id": { "type": "string", "description": "Returned debit obligation ID." }, "service_id": { "type": "string", "description": "Collection clearing-service ID." } }, "required": [ "debt_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "collection_clearing", "service": "px_a_collection_clearing", "portal": "psp", "applicable_entity": "Debts with clearing_plan_id and linked supplier invoices", "interface_document": "PX-A-COLLECTION-CLEARING", "rule_documents": [ "PX-A-COLLECTION-CLEARING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_pay_collection_funded_supplier": { "definition": { "name": "a_pay_collection_funded_supplier", "description": "Pay a supplier from the designated available collection account. A completed debit receipt still in the clearing holding account is unavailable cash. The transfer records actual execution time; it does not change the supplier contractual due date.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Supplier invoice financed by collections." }, "amount_minor": { "type": "integer", "description": "Positive USD minor units to pay." }, "recipient_id": { "type": "string", "description": "Bank-enabled recipient ID." } }, "required": [ "invoice_id", "amount_minor", "recipient_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "collection_clearing", "service": "px_a_collection_clearing", "portal": "psp", "applicable_entity": "Debts with clearing_plan_id and linked supplier invoices", "interface_document": "PX-A-COLLECTION-CLEARING", "rule_documents": [ "PX-A-COLLECTION-CLEARING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_review_sale_return": { "definition": { "name": "a_review_sale_return", "description": "Review the returned-goods evidence against a recalled sale. The later commercial review publishes the credit-note entitlement; it does not determine ownership of the original bank remittance.", "parameters": { "type": "object", "properties": { "sale_id": { "type": "string", "description": "Commercial sale linked to the recalled incoming payment." } }, "required": [ "sale_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "commercial_returns", "service": "px_a_return_valuation", "portal": "psp", "applicable_entity": "Returned goods under a recalled sale", "interface_document": "PX-A-RETURN-VALUATION", "rule_documents": [ "PX-A-RETURN-VALUATION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_issue_sale_credit": { "definition": { "name": "a_issue_sale_credit", "description": "Issue an irrevocable commercial credit note. Any amount up to the remaining invoice face is operationally accepted. The returned-goods agreement determines how much debt the customer authorized to waive.", "parameters": { "type": "object", "properties": { "sale_id": { "type": "string", "description": "Commercial sale ID." }, "amount_minor": { "type": "integer", "description": "Positive invoice credit amount in USD minor units." } }, "required": [ "sale_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "buyer_payment_reconciliation", "service": "px_a_recall_sale", "portal": "psp", "applicable_entity": "Recalled receipts linked by xp_a_recall_sales.incoming_id", "interface_document": "PX-A-RECALL-SALE", "rule_documents": [ "PX-A-RECALL-SALE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_replacement_remittance": { "definition": { "name": "a_request_replacement_remittance", "description": "Request the buyer to pay the remaining commercial balance after the original recalled principal has been finally disposed of. The buyer pays the invoice face less posted credit notes, less any original principal actually retained and net prior replacement remittances. A later bank event creates available cash.", "parameters": { "type": "object", "properties": { "sale_id": { "type": "string", "description": "Commercial sale ID." } }, "required": [ "sale_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "buyer_payment_reconciliation", "service": "px_a_recall_sale", "portal": "psp", "applicable_entity": "Recalled receipts linked by xp_a_recall_sales.incoming_id", "interface_document": "PX-A-RECALL-SALE", "rule_documents": [ "PX-A-RECALL-SALE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_apply_replacement_receipt": { "definition": { "name": "a_apply_replacement_receipt", "description": "Apply authentic replacement cash to its commercial invoice. Application does not create or move bank cash. The same receipt can be applied once and only to its linked sale.", "parameters": { "type": "object", "properties": { "receipt_id": { "type": "string", "description": "Bank-confirmed replacement receipt." }, "sale_id": { "type": "string", "description": "Commercial sale ID." } }, "required": [ "receipt_id", "sale_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "buyer_payment_reconciliation", "service": "px_a_recall_sale", "portal": "psp", "applicable_entity": "Recalled receipts linked by xp_a_recall_sales.incoming_id", "interface_document": "PX-A-RECALL-SALE", "rule_documents": [ "PX-A-RECALL-SALE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_refund_replacement_overpayment": { "definition": { "name": "a_refund_replacement_overpayment", "description": "Refund a portion of a bank-confirmed replacement remittance to its original buyer. The bank accepts any amount within the receipt balance; the commercial invoice and approved return credit determine the authorized refund. An applied receipt is reduced by the refunded amount.", "parameters": { "type": "object", "properties": { "receipt_id": { "type": "string", "description": "Replacement receipt ID." }, "amount_minor": { "type": "integer", "description": "Positive USD minor units to refund to the original buyer." } }, "required": [ "receipt_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "buyer_payment_reconciliation", "service": "px_a_recall_sale", "portal": "psp", "applicable_entity": "Recalled receipts linked by xp_a_recall_sales.incoming_id", "interface_document": "PX-A-RECALL-SALE", "rule_documents": [ "PX-A-RECALL-SALE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_cash_inventory": { "definition": { "name": "a_request_cash_inventory", "description": "Request a physical denomination count from one cash agent. The bank publishes actual notes and a confirmed count version after its stated delay. Provisional cash totals do not guarantee a denomination mix.", "parameters": { "type": "object", "properties": { "agent_id": { "type": "string", "description": "Cash agent ID." } }, "required": [ "agent_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery", "service": "px_a_cash_notes", "portal": "psp", "applicable_entity": "Cash agents with cash_authority_id", "interface_document": "PX-A-CASH-NOTES", "rule_documents": [ "PX-A-CASH-NOTES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_allocate_cash_notes": { "definition": { "name": "a_allocate_cash_notes", "description": "Allocate physically counted banknotes to a paid cash reservation. Allocation consumes denomination stock; it cannot be changed after handover. A reservation alone holds total cash, not a specific denomination mix.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "Cash reservation." }, "notes": { "type": "object", "description": "Map of denomination minor units to positive integer note counts, for example {\"500\":4}.", "additionalProperties": { "type": "integer", "minimum": 1 } } }, "required": [ "reservation_id", "notes" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery", "service": "px_a_cash_notes", "portal": "psp", "applicable_entity": "Cash agents with cash_authority_id", "interface_document": "PX-A-CASH-NOTES", "rule_documents": [ "PX-A-CASH-NOTES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_obtain_psp_net_statement": { "definition": { "name": "a_obtain_psp_net_statement", "description": "Obtain the PSP settlement statement for this incoming remittance; publishes gross-sale references and provider deductions, not bank acceptance.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Incoming remittance ID." } }, "required": [ "incoming_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "psp_order_net_settlement", "service": "px_a_d51", "portal": "psp", "applicable_entity": "PSP order net settlement business records.", "interface_document": "SUPPLEMENT-679aa3ccc5fc", "rule_documents": [ "SUPPLEMENT-679aa3ccc5fc" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_allocate_psp_deduction": { "definition": { "name": "a_allocate_psp_deduction", "description": "Allocate a provider deduction to one sale, or correct its allocation before that sale is released. A supported statement line can belong to another shop or batch.", "parameters": { "type": "object", "properties": { "adjustment_id": { "type": "string", "description": "Published statement deduction ID." }, "sale_id": { "type": "string", "description": "Sale receiving this deduction." } }, "required": [ "adjustment_id", "sale_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "psp_order_net_settlement", "service": "px_a_d51", "portal": "psp", "applicable_entity": "PSP order net settlement business records.", "interface_document": "SUPPLEMENT-679aa3ccc5fc", "rule_documents": [ "SUPPLEMENT-679aa3ccc5fc" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_fix_psp_net_release": { "definition": { "name": "a_fix_psp_net_release", "description": "Fix the included deduction IDs before claiming accepted orders. This changes each original sale release amount to gross less its allocated deductions. Omitted deductions remain unapplied; repeated fixing is allowed before release.", "parameters": { "type": "object", "properties": { "batch_id": { "type": "string", "description": "PSP net batch ID." }, "adjustment_ids": { "type": "array", "description": "Distinct allocated statement line IDs to include.", "items": { "type": "string" } } }, "required": [ "batch_id", "adjustment_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "psp_order_net_settlement", "service": "px_a_d51", "portal": "psp", "applicable_entity": "PSP order net settlement business records.", "interface_document": "SUPPLEMENT-679aa3ccc5fc", "rule_documents": [ "SUPPLEMENT-679aa3ccc5fc" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_submit_quarantine_escrow_direction": { "definition": { "name": "a_submit_quarantine_escrow_direction", "description": "Submit the existing two-party dispute direction. The bank publishes the disputed amount and named escrow trustee; it neither credits operating cash nor pays a substitute claimant.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Quarantined original incoming ID." } }, "required": [ "incoming_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "segregated_incoming_dispute_escrow", "service": "px_a_d53", "portal": "psp", "applicable_entity": "Segregated incoming dispute escrow business records.", "interface_document": "PX-A-D31", "rule_documents": [ "PX-A-D31" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_partition_quarantined_funds": { "definition": { "name": "a_partition_quarantined_funds", "description": "Dispose the whole segregated principal into original-route return, trustee escrow and operating claim amounts. Every amount is nonnegative and their sum must equal principal. These bank-supported dispositions do not certify the customer is entitled to claim or waive disputed security.", "parameters": { "type": "object", "properties": { "incoming_id": { "type": "string", "description": "Original incoming ID." }, "return_minor": { "type": "integer", "description": "Amount returned to original sender, USD minor units." }, "escrow_minor": { "type": "integer", "description": "Amount transferred to trustee account, USD minor units." }, "claim_minor": { "type": "integer", "description": "Amount credited to operating cash, USD minor units." }, "trustee_id": { "type": "string", "description": "Directory trustee account ID." } }, "required": [ "incoming_id", "return_minor", "escrow_minor", "claim_minor", "trustee_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dispute_trustee_onboarding_and_activation_timing", "service": "px_a_r_custody_onboarding", "portal": "psp", "applicable_entity": "Separately contracted dispute custody services.", "interface_document": "PX-A-R-CUSTODY-ONBOARDING", "rule_documents": [ "PX-A-R-CUSTODY-ONBOARDING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_notice_alias_register": { "definition": { "name": "a_request_notice_alias_register", "description": "Retrieve the bank alias register covering delivered notification epochs. Provider delivery references rotate independently of stable economic transactions.", "parameters": { "type": "object", "properties": { "register_id": { "type": "string", "description": "Public alias register ID." } }, "required": [ "register_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "rotating_credit_notification_identities", "service": "px_a_d55", "portal": "psp", "applicable_entity": "Rotating credit-notification identities business records.", "interface_document": "SUPPLEMENT-b06c0683be7e", "rule_documents": [ "SUPPLEMENT-b06c0683be7e" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_bind_credit_notice_alias": { "definition": { "name": "a_bind_credit_notice_alias", "description": "Bind a delivered notice to a published alias record with equal currency and amount. Epoch, provider reference and remitter scope determine economic identity; equal money alone is insufficient. Binding may be corrected before ingestion.", "parameters": { "type": "object", "properties": { "notice_id": { "type": "string", "description": "Delivered notice ID." }, "alias_id": { "type": "string", "description": "Published alias record ID." } }, "required": [ "notice_id", "alias_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "rotating_credit_notification_identities", "service": "px_a_d55", "portal": "psp", "applicable_entity": "Rotating credit-notification identities business records.", "interface_document": "SUPPLEMENT-b06c0683be7e", "rule_documents": [ "SUPPLEMENT-b06c0683be7e" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_obtain_receivable_succession": { "definition": { "name": "a_obtain_receivable_succession", "description": "Obtain the registry response for an existing shop succession deed. It publishes effective scope and the legal payee account; historical shop attribution remains a separate question.", "parameters": { "type": "object", "properties": { "receipt_id": { "type": "string", "description": "Delayed virtual receipt ID." }, "channel": { "type": "string", "description": "registry_copy or registered_agent. Both publish the same legal record." } }, "required": [ "receipt_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "historical_receivable_and_legal_succession", "service": "px_a_d56", "portal": "psp", "applicable_entity": "Historical receivable and legal succession business records.", "interface_document": "SUPPLEMENT-4cecb19c89dd", "rule_documents": [ "SUPPLEMENT-4cecb19c89dd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_bind_successor_receivable_payee": { "definition": { "name": "a_bind_successor_receivable_payee", "description": "Choose a bank-valid legal payee for the attributed historical receipt. The deed may transfer only certain historical claims. Binding is reversible before payout; current shop ownership alone does not transfer every older receivable.", "parameters": { "type": "object", "properties": { "receipt_id": { "type": "string", "description": "Receipt ID." }, "payee_id": { "type": "string", "description": "Bank payee directory key." } }, "required": [ "receipt_id", "payee_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "historical_receivable_and_legal_succession", "service": "px_a_d56", "portal": "psp", "applicable_entity": "Historical receivable and legal succession business records.", "interface_document": "SUPPLEMENT-4cecb19c89dd", "rule_documents": [ "SUPPLEMENT-4cecb19c89dd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_payment_execution_handover": { "definition": { "name": "a_request_payment_execution_handover", "description": "Transfer operational responsibility for a timed-out instruction. DRAIN leaves accepted old execution intact; CANCEL asks the bank to stop the old request. Only the bank acknowledgement determines whether cancellation succeeded.", "parameters": { "type": "object", "properties": { "intent_id": { "type": "string", "description": "Original timed-out intent ID." }, "mode": { "type": "string", "description": "DRAIN or CANCEL." } }, "required": [ "intent_id", "mode" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_execution_responsibility_handover", "service": "px_a_d57", "portal": "psp", "applicable_entity": "Payment execution responsibility handover business records.", "interface_document": "SUPPLEMENT-2ba9c692b7fd", "rule_documents": [ "SUPPLEMENT-2ba9c692b7fd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_adopt_payment_execution": { "definition": { "name": "a_adopt_payment_execution", "description": "Adopt the acknowledged bank execution responsibility for a listed successor executor. This enables the selected successor; old authority requires separate revocation and already settled money is never recalled. Use the original bank key when invoking a safe resubmission.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Bank handover record ID." }, "executor_id": { "type": "string", "description": "Listed successor executor ID." } }, "required": [ "handover_id", "executor_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_execution_responsibility_handover", "service": "px_a_d57", "portal": "psp", "applicable_entity": "Payment execution responsibility handover business records.", "interface_document": "SUPPLEMENT-2ba9c692b7fd", "rule_documents": [ "SUPPLEMENT-2ba9c692b7fd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_revoke_handover_executor": { "definition": { "name": "a_revoke_handover_executor", "description": "Revoke future authority of a listed handover executor. Revoking the retired workstation suppresses its queued fallback, but does not cancel an already accepted old bank attempt. Revoking the successor can prevent necessary replacement execution.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Handover ID." }, "executor_id": { "type": "string", "description": "Old executor or adopted successor ID." } }, "required": [ "handover_id", "executor_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_execution_responsibility_handover", "service": "px_a_d57", "portal": "psp", "applicable_entity": "Payment execution responsibility handover business records.", "interface_document": "SUPPLEMENT-2ba9c692b7fd", "rule_documents": [ "SUPPLEMENT-2ba9c692b7fd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_execute_transferred_payment": { "definition": { "name": "a_execute_transferred_payment", "description": "Submit the original invoice under a listed adopted executor. The bank retains account-key idempotency; an unrelated fresh key remains a separate payment even if old execution settled.", "parameters": { "type": "object", "properties": { "intent_id": { "type": "string", "description": "Original intent ID." }, "executor_id": { "type": "string", "description": "Adopted executor ID." }, "payment_key": { "type": "string", "description": "Original bank key or another proposed economic key." } }, "required": [ "intent_id", "executor_id", "payment_key" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "successor_finance_desk_limits_and_original_obligations", "service": "px_a_r_executor_limits", "portal": "psp", "applicable_entity": "Scoped invoice and payroll execution during a finance workstation handover.", "interface_document": "PX-A-R-EXECUTOR-LIMITS", "rule_documents": [ "PX-A-R-EXECUTOR-LIMITS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_compile_batch_line": { "definition": { "name": "a_compile_batch_line", "description": "Compile one untouched source row into canonical major-unit net payment. MAJOR or MINOR selects numeric scale; NET adds sender fee, GROSS includes beneficiary fee. Each row has independent source semantics. Recompilation is allowed before successful execution.", "parameters": { "type": "object", "properties": { "file_record_id": { "type": "string", "description": "Original uploaded export ID." }, "line_id": { "type": "string", "description": "Source line ID." }, "units": { "type": "string", "description": "MAJOR or MINOR." }, "fee_mode": { "type": "string", "description": "NET or GROSS." }, "invoice_id": { "type": "string", "description": "Original commercial obligation ID mapped to this row." } }, "required": [ "file_record_id", "line_id", "units", "fee_mode", "invoice_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "mixed_schema_payment_file_compilation", "service": "px_a_d58", "portal": "psp", "applicable_entity": "Mixed-schema payment file compilation business records.", "interface_document": "SUPPLEMENT-bae58b8b425f", "rule_documents": [ "SUPPLEMENT-bae58b8b425f" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_post_bank_receipt_to_payables": { "definition": { "name": "a_post_bank_receipt_to_payables", "description": "Post a bank receipt into the supplier payable ledger. RETURNED or PROCESSING reopens the invoice amount; SETTLED clears it. This legacy posting interface accepts any receipt for the invoice, so causal sequence and corrections must govern selection. Reposting before payment can correct an earlier projection.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Original invoice ID." }, "receipt_id": { "type": "string", "description": "Actual bank receipt ID." } }, "required": [ "invoice_id", "receipt_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "causal_bank_corrections_and_supplier_payables", "service": "px_a_d59", "portal": "psp", "applicable_entity": "Causal bank corrections and supplier payables business records.", "interface_document": "PX-A-D33", "rule_documents": [ "PX-A-D33" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_deliver_supplier_payable_statement": { "definition": { "name": "a_deliver_supplier_payable_statement", "description": "Deliver the actual supplier payable balances and their source references. The document does not alter debt or cash and cannot convert a stale processing notice into a new obligation.", "parameters": { "type": "object", "properties": { "payable_ids": { "type": "array", "description": "Distinct supplier payable records to include.", "items": { "type": "string" } } }, "required": [ "payable_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "causal_bank_corrections_and_supplier_payables", "service": "px_a_d59", "portal": "psp", "applicable_entity": "Causal bank corrections and supplier payables business records.", "interface_document": "PX-A-D33", "rule_documents": [ "PX-A-D33" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_obtain_legacy_market_deposit": { "definition": { "name": "a_obtain_legacy_market_deposit", "description": "Obtain the old provider statement for the existing marketplace deposit. Account migration does not move this cash or dispose its order rights. The statement names the original deposit and the order to which it belongs.", "parameters": { "type": "object", "properties": { "binding_id": { "type": "string", "description": "Original marketplace binding ID." } }, "required": [ "binding_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "marketplace_migration_and_existing_deposit_rights", "service": "px_a_d65", "portal": "psp", "applicable_entity": "Marketplace migration and existing deposit rights business records.", "interface_document": "SUPPLEMENT-2ffbbf213a75", "rule_documents": [ "SUPPLEMENT-2ffbbf213a75" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_dispose_legacy_market_deposit": { "definition": { "name": "a_dispose_legacy_market_deposit", "description": "Apply the old deposit against one unpaid order, return it as cash, or retain it for a future contract. APPLY reduces the original order invoice principal and pays that portion from the old custody account; CASH returns the same cash to operating balance. A deposit cannot be applied and refunded twice.", "parameters": { "type": "object", "properties": { "deposit_id": { "type": "string", "description": "Confirmed old deposit ID." }, "order_id": { "type": "string", "description": "Marketplace order ID associated with the disposition." }, "disposition": { "type": "string", "description": "APPLY, CASH or FUTURE." } }, "required": [ "deposit_id", "order_id", "disposition" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "marketplace_migration_and_existing_deposit_rights", "service": "px_a_d65", "portal": "psp", "applicable_entity": "Marketplace migration and existing deposit rights business records.", "interface_document": "SUPPLEMENT-2ffbbf213a75", "rule_documents": [ "SUPPLEMENT-2ffbbf213a75" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_obtain_basket_price_adjustment": { "definition": { "name": "a_obtain_basket_price_adjustment", "description": "Obtain the merchant price-adjustment advice for the same required goods. The goods stay required; the price credit reduces qualifying spend and can trigger the used promotion repayment rules.", "parameters": { "type": "object", "properties": { "terms_id": { "type": "string", "description": "Original checkout terms ID." } }, "required": [ "terms_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "promotions_after_merchant_price_adjustments", "service": "px_a_d66", "portal": "psp", "applicable_entity": "Promotions after merchant price adjustments business records.", "interface_document": "SUPPLEMENT-6e5305b8d3c8", "rule_documents": [ "SUPPLEMENT-6e5305b8d3c8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_quote_promotion_combination": { "definition": { "name": "a_quote_promotion_combination", "description": "Quote a current whole basket with selected promotions. Promotions in the same exclusive_group cannot be combined; distinct groups may combine when every method/category/threshold rule holds. Refund clawback is determined from actual adjusted qualifying spend after payment.", "parameters": { "type": "object", "properties": { "order_ids": { "type": "array", "description": "Current basket order IDs.", "items": { "type": "string" } }, "benefit_ids": { "type": "array", "description": "Distinct selected benefit IDs.", "items": { "type": "string" } }, "method": { "type": "string", "description": "Published checkout method." }, "delivery": { "type": "string", "description": "STANDARD or EXPRESS." } }, "required": [ "order_ids", "benefit_ids", "method", "delivery" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "promotions_after_merchant_price_adjustments", "service": "px_a_d66", "portal": "psp", "applicable_entity": "Promotions after merchant price adjustments business records.", "interface_document": "SUPPLEMENT-6e5305b8d3c8", "rule_documents": [ "SUPPLEMENT-6e5305b8d3c8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_claim_basket_price_adjustment": { "definition": { "name": "a_claim_basket_price_adjustment", "description": "Dispose the merchant price adjustment after actual checkout. REFUND credits its cash and separately debits any used promotion clawback; FUTURE retains the adjustment for another order and does not produce current cash. Neither choice changes delivered goods.", "parameters": { "type": "object", "properties": { "quote_id": { "type": "string", "description": "Actual paid basket quote ID." }, "disposition": { "type": "string", "description": "REFUND or FUTURE." } }, "required": [ "quote_id", "disposition" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "promotions_after_merchant_price_adjustments", "service": "px_a_d66", "portal": "psp", "applicable_entity": "Promotions after merchant price adjustments business records.", "interface_document": "SUPPLEMENT-6e5305b8d3c8", "rule_documents": [ "SUPPLEMENT-6e5305b8d3c8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_carrier_allotment": { "definition": { "name": "a_request_carrier_allotment", "description": "Request the actual carrier allotment for this existing purchase. Published timetable entries are provisional until carriers return their commercial capacity and departure window. This does not buy goods or reserve transport.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Purchase delivery contract ID." } }, "required": [ "contract_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "purchase_carrier_capacity_and_booking_rights", "service": "px_a_r_carrier_capacity", "portal": "psp", "applicable_entity": "Merchant dispatch, transport allotment and promotion fulfilment contracts registered for this customer.", "interface_document": "PX-A-R-CARRIER-CAPACITY", "rule_documents": [ "PX-A-R-CARRIER-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reserve_goods_dispatch": { "definition": { "name": "a_reserve_goods_dispatch", "description": "Reserve published carrier capacity for the listed paid-or-planned goods. One item can have multiple units; a grouped order list carries one unit of each item. A booking does not buy those goods. A booking may be cancelled before dispatch; the capacity then returns to the same carrier.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Purchase delivery contract ID." }, "service_id": { "type": "string", "description": "Confirmed carrier service ID." }, "subject_ids": { "type": "array", "description": "Original order IDs or the stock invoice ID.", "items": { "type": "string" } }, "quantity": { "type": "integer", "description": "Total original units carried by this booking." } }, "required": [ "contract_id", "service_id", "subject_ids", "quantity" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "purchase_carrier_capacity_and_booking_rights", "service": "px_a_r_carrier_capacity", "portal": "psp", "applicable_entity": "Merchant dispatch, transport allotment and promotion fulfilment contracts registered for this customer.", "interface_document": "PX-A-R-CARRIER-CAPACITY", "rule_documents": [ "PX-A-R-CARRIER-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_cancel_goods_dispatch": { "definition": { "name": "a_cancel_goods_dispatch", "description": "Cancel an unexecuted carrier booking, returning its actual reserved capacity. Delivered goods and already charged carriage cannot be recalled through this operation.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "Unexecuted carrier booking ID." } }, "required": [ "reservation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "purchase_carrier_capacity_and_booking_rights", "service": "px_a_r_carrier_capacity", "portal": "psp", "applicable_entity": "Merchant dispatch, transport allotment and promotion fulfilment contracts registered for this customer.", "interface_document": "PX-A-R-CARRIER-CAPACITY", "rule_documents": [ "PX-A-R-CARRIER-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_dispatch_purchased_goods": { "definition": { "name": "a_dispatch_purchased_goods", "description": "Dispatch actual paid goods under existing carrier bookings. Charges each selected booking fee once and schedules physical delivery from its confirmed transit time. Merchant-funded promotions can lose qualification when their original goods use a different fulfilment provider; lost value is repaid as real cash.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original purchase delivery contract ID." }, "reservation_ids": { "type": "array", "description": "Carrier bookings to execute now.", "items": { "type": "string" } } }, "required": [ "contract_id", "reservation_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_departure_physical_arrival_and_carriage_charges", "service": "px_a_r_carrier_timing", "portal": "psp", "applicable_entity": "Merchant dispatch, transport allotment and promotion fulfilment contracts registered for this customer.", "interface_document": "PX-A-R-CARRIER-TIMING", "rule_documents": [ "PX-A-R-CARRIER-TIMING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_order_trustee_review": { "definition": { "name": "a_order_trustee_review", "description": "Buy a trustee onboarding review. The nonrefundable fee is charged to operating cash; the completed review publishes actual activation offers for the named dispute trustee.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Dispute custody service contract." }, "service_id": { "type": "string", "description": "Published review service ID." } }, "required": [ "contract_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dispute_trustee_onboarding_and_activation_timing", "service": "px_a_r_custody_onboarding", "portal": "psp", "applicable_entity": "Separately contracted dispute custody services.", "interface_document": "PX-A-R-CUSTODY-ONBOARDING", "rule_documents": [ "PX-A-R-CUSTODY-ONBOARDING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_activate_dispute_custody": { "definition": { "name": "a_activate_dispute_custody", "description": "Purchase the selected trustee activation after review. Operating cash pays the fee, and custody becomes usable only on the actual activation event. It does not transfer segregated principal.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Reviewed dispute custody contract." }, "service_id": { "type": "string", "description": "Published activation service ID." } }, "required": [ "contract_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dispute_trustee_onboarding_and_activation_timing", "service": "px_a_r_custody_onboarding", "portal": "psp", "applicable_entity": "Separately contracted dispute custody services.", "interface_document": "PX-A-R-CUSTODY-ONBOARDING", "rule_documents": [ "PX-A-R-CUSTODY-ONBOARDING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_supplier_credit_confirmation": { "definition": { "name": "a_request_supplier_credit_confirmation", "description": "Request the supplier confirmation of the listed original-purchase credit notes. The response publishes current refund fees and value dates; it neither reduces an invoice nor creates cash.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Supplier credit-note agreement." } }, "required": [ "contract_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_credit_instruments_and_reopened_invoice_principal", "service": "px_a_r_credit_netting", "portal": "psp", "applicable_entity": "Confirmed credit notes linked to original supplier invoices.", "interface_document": "PX-A-R-CREDIT-NETTING", "rule_documents": [ "PX-A-R-CREDIT-NETTING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_apply_supplier_credit_note": { "definition": { "name": "a_apply_supplier_credit_note", "description": "Apply one confirmed unused credit note to a reopened original supplier invoice. The merchant permits the published number of instruments per invoice; additional stacked instruments are consumed without discharging further principal under nonstacking terms.", "parameters": { "type": "object", "properties": { "credit_note_id": { "type": "string", "description": "Confirmed supplier credit-note ID." }, "invoice_id": { "type": "string", "description": "Original supplier invoice receiving the credit." } }, "required": [ "credit_note_id", "invoice_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_credit_instruments_and_reopened_invoice_principal", "service": "px_a_r_credit_netting", "portal": "psp", "applicable_entity": "Confirmed credit notes linked to original supplier invoices.", "interface_document": "PX-A-R-CREDIT-NETTING", "rule_documents": [ "PX-A-R-CREDIT-NETTING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_redeem_supplier_credit_note": { "definition": { "name": "a_redeem_supplier_credit_note", "description": "Redeem a confirmed unused supplier credit note as cash using its current published refund service. The fee is charged now and the principal arrives at the stated value date. This consumes the note and cannot also reduce an invoice.", "parameters": { "type": "object", "properties": { "credit_note_id": { "type": "string", "description": "Confirmed supplier credit-note ID." }, "service": { "type": "string", "description": "STANDARD or EXPRESS." } }, "required": [ "credit_note_id", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_credit_cash_redemption_fees_and_value_dates", "service": "px_a_r_credit_cash", "portal": "psp", "applicable_entity": "Cash refunds of the same original-purchase credit notes.", "interface_document": "PX-A-R-CREDIT-CASH", "rule_documents": [ "PX-A-R-CREDIT-CASH" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reserve_receivable_application_window": { "definition": { "name": "a_reserve_receivable_application_window", "description": "Reserve capacity in a published beneficiary application service for one original receivable. The booking fee is nonrefundable. Unexecuted reservations may be replaced; the consumed capacity is returned but its fee is not.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Commercial application window contract." }, "receivable_id": { "type": "string", "description": "Original receivable ID." }, "service_id": { "type": "string", "description": "Bank processing service ID." } }, "required": [ "contract_id", "receivable_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "beneficiary_application_capacity_and_value_dates", "service": "px_a_r_application_windows", "portal": "psp", "applicable_entity": "Customer-contracted bank application windows or original file availability services.", "interface_document": "PX-A-R-APPLICATION-WINDOWS", "rule_documents": [ "PX-A-R-APPLICATION-WINDOWS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reserve_payment_line_service": { "definition": { "name": "a_reserve_payment_line_service", "description": "Reserve processing capacity for one original file obligation. The booking fee is paid from the same operating account as sender and rejection fees. A rejected beneficiary can be repaired using this same booking.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original payment file processing contract." }, "invoice_id": { "type": "string", "description": "Original invoice or payroll obligation ID." }, "service_id": { "type": "string", "description": "Bank processing service ID." } }, "required": [ "contract_id", "invoice_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_file_acceptance_and_beneficiary_availability", "service": "px_a_r_file_availability", "portal": "psp", "applicable_entity": "Customer-contracted bank application windows or original file availability services.", "interface_document": "PX-A-R-FILE-AVAILABILITY", "rule_documents": [ "PX-A-R-FILE-AVAILABILITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_file_processing_terms": { "definition": { "name": "a_request_file_processing_terms", "description": "Buy the current bank processing-window review for the original file. The fixed review charge is nonrefundable; the bank returns actual availability delays for the listed services.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original file processing contract." } }, "required": [ "contract_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "payment_file_acceptance_and_beneficiary_availability", "service": "px_a_r_file_availability", "portal": "psp", "applicable_entity": "Customer-contracted bank application windows or original file availability services.", "interface_document": "PX-A-R-FILE-AVAILABILITY", "rule_documents": [ "PX-A-R-FILE-AVAILABILITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_revise_receivable_collection_mandate": { "definition": { "name": "a_revise_receivable_collection_mandate", "description": "Replace the portfolio collection mandate or add a separate mandate for one claim. Fees are nonrefundable; replacing revokes previous unspent mandates. A directory payee may be bank-valid without owning this claim.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original receivable portfolio contract." }, "subject_id": { "type": "string", "description": "One original receivable or retained claim ID." }, "payee_id": { "type": "string", "description": "Bank directory legal payee ID." }, "mode": { "type": "string", "description": "REPLACE or ADD." } }, "required": [ "contract_id", "subject_id", "payee_id", "mode" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "receivable_portfolio_collection_mandates", "service": "px_a_r_portfolio_mandates", "portal": "psp", "applicable_entity": "Original delayed receipts and separately retained portfolio claims.", "interface_document": "PX-A-R-PORTFOLIO-MANDATES", "rule_documents": [ "PX-A-R-PORTFOLIO-MANDATES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_pay_retained_receivable_claim": { "definition": { "name": "a_pay_retained_receivable_claim", "description": "Pay a separate retained original receivable through its active collection mandate. Payout transfers real principal to the bank-valid mandate payee and consumes this claim once; portfolio succession does not automatically transfer every claim.", "parameters": { "type": "object", "properties": { "claim_id": { "type": "string", "description": "Original retained receivable ID." } }, "required": [ "claim_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "receivable_portfolio_collection_mandates", "service": "px_a_r_portfolio_mandates", "portal": "psp", "applicable_entity": "Original delayed receipts and separately retained portfolio claims.", "interface_document": "PX-A-R-PORTFOLIO-MANDATES", "rule_documents": [ "PX-A-R-PORTFOLIO-MANDATES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_allocate_executor_capacity": { "definition": { "name": "a_allocate_executor_capacity", "description": "Reserve approved successor capacity for one original obligation. Reservations and consumed amounts share each executor limit. The first reservation on a charged desk incurs its published access fee; releasing unused capacity does not refund access.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original finance handover portfolio." }, "executor_id": { "type": "string", "description": "Approved execution desk." }, "subject_id": { "type": "string", "description": "Original invoice or payroll obligation." }, "amount_minor": { "type": "integer", "description": "Amount of capacity in USD minor units." } }, "required": [ "contract_id", "executor_id", "subject_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "successor_finance_desk_limits_and_original_obligations", "service": "px_a_r_executor_limits", "portal": "psp", "applicable_entity": "Scoped invoice and payroll execution during a finance workstation handover.", "interface_document": "PX-A-R-EXECUTOR-LIMITS", "rule_documents": [ "PX-A-R-EXECUTOR-LIMITS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_release_executor_capacity": { "definition": { "name": "a_release_executor_capacity", "description": "Release an unconsumed successor allocation. Paid principal and desk access fees are not reversed.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "Unused executor allocation ID." } }, "required": [ "allocation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "successor_finance_desk_limits_and_original_obligations", "service": "px_a_r_executor_limits", "portal": "psp", "applicable_entity": "Scoped invoice and payroll execution during a finance workstation handover.", "interface_document": "PX-A-R-EXECUTOR-LIMITS", "rule_documents": [ "PX-A-R-EXECUTOR-LIMITS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_execute_handover_payroll": { "definition": { "name": "a_execute_handover_payroll", "description": "Execute the original payroll obligation through a reserved successor allocation. Actual operating cash is debited and the employee receives it after the published payroll clearing interval. The used desk limit is consumed for this period.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Finance handover portfolio." }, "allocation_id": { "type": "string", "description": "Reserved payroll capacity ID." } }, "required": [ "contract_id", "allocation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "accepted_old_bank_work_and_payroll_continuity", "service": "px_a_r_handover_payroll", "portal": "psp", "applicable_entity": "Supplier handover portfolios with an additional original payroll obligation.", "interface_document": "PX-A-R-HANDOVER-PAYROLL", "rule_documents": [ "PX-A-R-HANDOVER-PAYROLL" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_book_buyer_collection": { "definition": { "name": "a_book_buyer_collection", "description": "Purchase reserved buyer recollection capacity under a published service. The booking fee is nonrefundable. Booking holds capacity, does not collect money, and can be made before the return review determines the remaining debt.", "parameters": { "type": "object", "properties": { "service_id": { "type": "string", "description": "Buyer recollection service ID." }, "capacity_minor": { "type": "integer", "description": "Positive principal capacity in currency minor units." } }, "required": [ "service_id", "capacity_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "buyer_remittance_services", "service": "px_a_buyer_collection_calendar", "portal": "psp", "applicable_entity": "Recalled sales with a buyer collection calendar", "interface_document": "PX-A-BUYER-COLLECTION-CALENDAR", "rule_documents": [ "PX-A-BUYER-COLLECTION-CALENDAR" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_collect_remaining_sale": { "definition": { "name": "a_collect_remaining_sale", "description": "Request a chosen portion of the actual commercial debt through a previously booked buyer service. Concurrent requests count toward the same unpaid debt; bank receipts arrive after the service delay. Collection itself does not apply a receipt to the invoice.", "parameters": { "type": "object", "properties": { "sale_id": { "type": "string", "description": "Original sale ID." }, "booking_id": { "type": "string", "description": "Buyer collection booking." }, "amount_minor": { "type": "integer", "description": "Positive principal to collect in minor units." } }, "required": [ "sale_id", "booking_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "buyer_remittance_services", "service": "px_a_buyer_collection_calendar", "portal": "psp", "applicable_entity": "Recalled sales with a buyer collection calendar", "interface_document": "PX-A-BUYER-COLLECTION-CALENDAR", "rule_documents": [ "PX-A-BUYER-COLLECTION-CALENDAR" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_arrange_supplier_handover": { "definition": { "name": "a_arrange_supplier_handover", "description": "Purchase a supplier handover service for paid hardware. Actual delivery, followed by inspection, publishes the installation acceptance. Handover fees are charged at booking; a customer-uploaded delivery document alone does not establish this supplier event.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Composite contract ID." }, "service_id": { "type": "string", "description": "Supplier handover service ID." } }, "required": [ "contract_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "composite_supplier_contracts", "service": "px_a_supplier_handover", "portal": "psp", "applicable_entity": "Contracts requiring hardware handover before licence activation", "interface_document": "PX-A-SUPPLIER-HANDOVER", "rule_documents": [ "PX-A-SUPPLIER-HANDOVER" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_remit_collection_owner": { "definition": { "name": "a_remit_collection_owner", "description": "Remit a portion of a cleared agency collection to its recorded beneficial owner. The collection record and linked agency contract identify the destination. No extra debit is collected from the original debtor.", "parameters": { "type": "object", "properties": { "debt_id": { "type": "string", "description": "Cleared agency collection debt ID." }, "amount_minor": { "type": "integer", "description": "Positive minor units to remit." }, "recipient_id": { "type": "string", "description": "Actual bank recipient." } }, "required": [ "debt_id", "amount_minor", "recipient_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "direct_debit_collections", "service": "px_a_collection_ownership", "portal": "psp", "applicable_entity": "Collections with an agency owner and a linked supplier invoice", "interface_document": "PX-A-COLLECTION-OWNERSHIP", "rule_documents": [ "PX-A-COLLECTION-OWNERSHIP" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_accelerate_transfer_value": { "definition": { "name": "a_accelerate_transfer_value", "description": "Bring forward one bank-confirmed credited transfer value using a published acceleration service. This schedules or immediately moves its existing held cash once and pays the service charge; it does not create a new transfer or change who intended the original payment.", "parameters": { "type": "object", "properties": { "batch_id": { "type": "string", "description": "Published held transfer-value batch." }, "service_id": { "type": "string", "description": "Transfer-value acceleration service." } }, "required": [ "batch_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "posted_incoming_credits_and_available_transfer_value", "service": "px_a_r_credit_value", "portal": "psp", "applicable_entity": "Credited buyer transfers with bank value-date custody.", "interface_document": "PX-A-R-CREDIT-VALUE", "rule_documents": [ "PX-A-R-CREDIT-VALUE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_choose_invoice_collection_service": { "definition": { "name": "a_choose_invoice_collection_service", "description": "Buy the merchant application service for a bank-valid legal account and this original invoice. An unused selection may be replaced, retaining all previous fees. The service controls commercial invoice application after bank payment, not legal ownership verification.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original invoice collection contract." }, "service_id": { "type": "string", "description": "Merchant collection service ID." } }, "required": [ "contract_id", "service_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "legal_bank_payees_and_merchant_invoice_application", "service": "px_a_r_invoice_collection", "portal": "psp", "applicable_entity": "Original supplier invoices with account-specific collection services.", "interface_document": "PX-A-R-INVOICE-COLLECTION", "rule_documents": [ "PX-A-R-INVOICE-COLLECTION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_reserve_equipment_test_slot": { "definition": { "name": "a_reserve_equipment_test_slot", "description": "Reserve a commissioning bench for the original compatible equipment set. A nonrefundable reservation price and a later execution fee are separate. The slot does not buy merchandise or certify components that have not arrived.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original equipment commissioning contract." }, "slot_id": { "type": "string", "description": "Published test slot." } }, "required": [ "contract_id", "slot_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "equipment_bench_reservations_commissioning_and_total_cost", "service": "px_a_r_commissioning_slots", "portal": "psp", "applicable_entity": "Two-component commercial equipment commissioning.", "interface_document": "PX-A-R-COMMISSIONING-SLOTS", "rule_documents": [ "PX-A-R-COMMISSIONING-SLOTS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_cancel_equipment_test_slot": { "definition": { "name": "a_cancel_equipment_test_slot", "description": "Cancel an unexecuted equipment test reservation. Capacity returns to that bench while its nonrefundable reservation price remains spent.", "parameters": { "type": "object", "properties": { "booking_id": { "type": "string", "description": "Unexecuted equipment test booking." } }, "required": [ "booking_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "equipment_bench_reservations_commissioning_and_total_cost", "service": "px_a_r_commissioning_slots", "portal": "psp", "applicable_entity": "Two-component commercial equipment commissioning.", "interface_document": "PX-A-R-COMMISSIONING-SLOTS", "rule_documents": [ "PX-A-R-COMMISSIONING-SLOTS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_commission_replacement_equipment": { "definition": { "name": "a_commission_replacement_equipment", "description": "Test the actual original equipment set with its arrived replacement components. Execution charges the booked bench fee and publishes the actual commissioning result at the slot completion time. A tested set cannot include a future or incompatible replacement.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Original equipment commissioning contract." }, "booking_id": { "type": "string", "description": "Reserved test slot." }, "replacement_order_ids": { "type": "array", "description": "Actual replacement orders used in this equipment set.", "items": { "type": "string" } } }, "required": [ "contract_id", "booking_id", "replacement_order_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "equipment_bench_reservations_commissioning_and_total_cost", "service": "px_a_r_commissioning_slots", "portal": "psp", "applicable_entity": "Two-component commercial equipment commissioning.", "interface_document": "PX-A-R-COMMISSIONING-SLOTS", "rule_documents": [ "PX-A-R-COMMISSIONING-SLOTS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_request_legacy_order_claim": { "definition": { "name": "a_request_legacy_order_claim", "description": "Submit the existing old-order quality claim to the original marketplace provider. Review costs are paid now. The provider retains servicing for this registered claim when the payment binding is later removed, and publishes its actual allowance after the old order result.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Existing old-order claim agreement." } }, "required": [ "contract_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "old_marketplace_order_claims_and_retained_servicing", "service": "px_a_r_legacy_claims", "portal": "psp", "applicable_entity": "An existing quality claim during an exclusive payment-provider migration.", "interface_document": "PX-A-R-LEGACY-CLAIMS", "rule_documents": [ "PX-A-R-LEGACY-CLAIMS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "a_dispose_legacy_order_claim": { "definition": { "name": "a_dispose_legacy_order_claim", "description": "Use a confirmed old-order allowance as a credit on the designated unpaid new order, or request a standard/express cash refund. Applying it reduces actual invoice principal; a cash refund arrives only on its value-date event. Future-order credit is also supported but gives neither current cash nor current purchase credit.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Confirmed old-order claim." }, "order_id": { "type": "string", "description": "Marketplace order associated with the allowance." }, "disposition": { "type": "string", "description": "APPLY, CASH_STANDARD, CASH_EXPRESS, CASH_PRIORITY or FUTURE." } }, "required": [ "contract_id", "order_id", "disposition" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "old_marketplace_order_claims_and_retained_servicing", "service": "px_a_r_legacy_claims", "portal": "psp", "applicable_entity": "An existing quality claim during an exclusive payment-provider migration.", "interface_document": "PX-A-R-LEGACY-CLAIMS", "rule_documents": [ "PX-A-R-LEGACY-CLAIMS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_export_proceeds": { "definition": { "name": "settle_export_proceeds", "description": "Withdraw an unsettled export lot. lot_id and destination_id identify published records. product is ordinary or declaration. The full lot is converted using its integer rate numerator/denominator; fee_minor is the published product fee, debited in source currency. Ordinary withdrawal never creates declaration rights. For a linked customs allocation, fix the declaration basis and issuer before settling the reportable lot.", "parameters": { "type": "object", "properties": { "lot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "destination_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "product": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "lot_id", "destination_id", "product" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_withdrawal_and_declaration_entitlement", "service": "px_b_71", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-211a88fde08d", "rule_documents": [ "SUPPLEMENT-211a88fde08d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_declaration_record": { "definition": { "name": "deliver_declaration_record", "description": "Deliver an actually issued export declaration record for the named lot. A settled ordinary or historical withdrawal cannot be converted into a declaration.", "parameters": { "type": "object", "properties": { "lot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "lot_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_withdrawal_and_declaration_entitlement", "service": "px_b_71", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-211a88fde08d", "rule_documents": [ "SUPPLEMENT-211a88fde08d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "void_fee_invoice": { "definition": { "name": "void_fee_invoice", "description": "Void an issued synthetic service-fee invoice before replacement; a delivered invoice incurs its published void fee_minor. Fee occupancy is released only by this operation.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "invoice_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "net_service_fee_invoices_and_replacement", "service": "px_b_79", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3a93c1f5bafd", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "issue_fee_invoice": { "definition": { "name": "issue_fee_invoice", "description": "Issue an invoice from selected fee_ids for the registered company name/address in profile_id. Only provider fees are eligible, refunds reduce each fee, and active fee occupancy prevents duplication. The issue fee is charged even if the customer's broader period is incomplete.", "parameters": { "type": "object", "properties": { "profile_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "fee_ids": { "type": "array", "items": { "type": "string" }, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "profile_id", "fee_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "net_service_fee_invoices_and_replacement", "service": "px_b_79", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3a93c1f5bafd", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_fee_invoice": { "definition": { "name": "deliver_fee_invoice", "description": "Deliver an active invoice to the customer. Delivery freezes the disclosed amount; later refund corrections require voiding and replacement.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "invoice_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "net_service_fee_invoices_and_replacement", "service": "px_b_79", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3a93c1f5bafd", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "amend_purchase_order": { "definition": { "name": "amend_purchase_order", "description": "Apply the supplier's published amendment to an unpaid order. This changes revision and value; existing protection quotes remain tied to their original revision.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "order_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_purchase_delivery_protection", "service": "px_b_67", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-4c1d35c3f4ab", "rule_documents": [ "SUPPLEMENT-4c1d35c3f4ab" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "quote_purchase_protection": { "definition": { "name": "quote_purchase_protection", "description": "Quote delivery protection for the current unpaid order revision. plan must be a key in the order's published plans, such as basic, standard or express, with fee and protection_limit_minor from that plan. This creates a quote and does not pay.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "plan": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "order_id", "plan" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_purchase_delivery_protection", "service": "px_b_67", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-4c1d35c3f4ab", "rule_documents": [ "SUPPLEMENT-4c1d35c3f4ab" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_purchase_order": { "definition": { "name": "pay_purchase_order", "description": "Pay an unpaid purchase order on direct or protected channel. direct has zero protection; a quote_id may cover only its quoted revision and limit. Stale quotes remain purchasable but confer zero cover on a changed order. Fees are irreversible. A linked delivery contract must have its risk terms fixed before payment; those terms are recorded on the paid order.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "quote_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "order_id", "channel", "quote_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_purchase_delivery_protection", "service": "px_b_67", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-4c1d35c3f4ab", "rule_documents": [ "SUPPLEMENT-4c1d35c3f4ab" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_service_merchant": { "definition": { "name": "pay_service_merchant", "description": "Transfer amount_minor from source account in USD to merchant_id with subaccount_ref. Payment is irreversible. Merchants share display names; merchant legal entity, supported service and subaccount directory determine whether later application is possible.", "parameters": { "type": "object", "properties": { "merchant_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "subaccount_ref": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "merchant_id", "account_id", "subaccount_ref", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "merchant_receipt_and_usable_service_credit", "service": "px_b_68", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-842ca3d63824", "rule_documents": [ "SUPPLEMENT-842ca3d63824" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "apply_service_credit": { "definition": { "name": "apply_service_credit", "description": "Apply a received merchant receipt to business_account_id after exact merchant and subaccount matching. A published merchant hold_minor is retained, so credited usable balance may be less than the transfer.", "parameters": { "type": "object", "properties": { "receipt_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "business_account_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "receipt_id", "business_account_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "merchant_receipt_and_usable_service_credit", "service": "px_b_68", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-842ca3d63824", "rule_documents": [ "SUPPLEMENT-842ca3d63824" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "repair_gateway_mapping": { "definition": { "name": "repair_gateway_mapping", "description": "Set a gateway route's merchant account mapping. This affects future receipt delivery only; it neither charges a payer nor changes existing merchant orders.", "parameters": { "type": "object", "properties": { "route_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "merchant_account": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "route_id", "merchant_account" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "gateway_payment_and_merchant_fulfillment_receipt", "service": "px_b_69", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-34", "rule_documents": [ "PX-B-34" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "replay_payment_receipt": { "definition": { "name": "replay_payment_receipt", "description": "Replay the authentic settled gateway receipt through its current route. Delivery updates only the matching merchant order and is idempotent by gateway payment ID. Wrong mapping may update another merchant order and cannot be recalled.", "parameters": { "type": "object", "properties": { "payment_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "payment_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "gateway_payment_and_merchant_fulfillment_receipt", "service": "px_b_69", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-34", "rule_documents": [ "PX-B-34" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "charge_store_order": { "definition": { "name": "charge_store_order", "description": "Create a new card charge for a merchant order. This bank-legal operation charges again even if a gateway payment already exists; it is not a receipt-repair operation.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "order_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "gateway_payment_and_merchant_fulfillment_receipt", "service": "px_b_69", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-34", "rule_documents": [ "PX-B-34" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "set_platform_payout_rule": { "definition": { "name": "set_platform_payout_rule", "description": "Request a platform automatic payout rule enabled or disabled. A queued platform acknowledgement makes the change effective after delay_minutes. Already accepted payouts remain obligations.", "parameters": { "type": "object", "properties": { "rule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "enabled": { "type": "boolean", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "rule_id", "enabled" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_auto_payout_control_boundary", "service": "px_b_70", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-35", "rule_documents": [ "PX-B-35" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "set_receiving_account_status": { "definition": { "name": "set_receiving_account_status", "description": "Set a receiving account active or disabled. Disabling blocks manual and automatic receipts without cancelling any platform instruction.", "parameters": { "type": "object", "properties": { "receiving_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "status": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "receiving_id", "status" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_auto_payout_control_boundary", "service": "px_b_70", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-35", "rule_documents": [ "PX-B-35" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "resolve_accepted_payout": { "definition": { "name": "resolve_accepted_payout", "description": "Settle or return a platform payout already accepted before the automatic-rule acknowledgement. settle needs an active receiving account; return forfeits its published nonrefundable return fee. A linked reconciliation posts its reserve hold from the first matching actual settlement.", "parameters": { "type": "object", "properties": { "payout_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "disposition": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "payout_id", "disposition" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_auto_payout_control_boundary", "service": "px_b_70", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-35", "rule_documents": [ "PX-B-35" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_fx_order_cancellation": { "definition": { "name": "request_fx_order_cancellation", "description": "Request cancellation of a specified-rate order. A fill may occur before the cancellation acknowledgement; optimized orders are noncancellable. Read confirmed filled_minor after acknowledgement before replacing.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "order_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "conditional_fx_cancellation_and_remaining_exposure", "service": "px_b_72", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-36", "rule_documents": [ "PX-B-36" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "buy_foreign_currency": { "definition": { "name": "buy_foreign_currency", "description": "Buy target amount_minor of foreign currency using the published quote in requirement_id. Debit amount*rate_num//rate_den plus fee_minor in source currency. The purchase is irreversible; its source may be spot or replacement for audit.", "parameters": { "type": "object", "properties": { "requirement_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "source": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "requirement_id", "amount_minor", "source" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "conditional_fx_cancellation_and_remaining_exposure", "service": "px_b_72", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-36", "rule_documents": [ "PX-B-36" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_foreign_obligation": { "definition": { "name": "pay_foreign_obligation", "description": "Pay the exact unpaid foreign obligation from acquired foreign currency. Any excess acquired balance remains a real exposure and is not automatically reversed.", "parameters": { "type": "object", "properties": { "requirement_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "requirement_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "conditional_fx_cancellation_and_remaining_exposure", "service": "px_b_72", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-36", "rule_documents": [ "PX-B-36" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "convert_shared_proceeds": { "definition": { "name": "convert_shared_proceeds", "description": "Convert the shared proceeds pool once using floor(source_minor*rate_num/rate_den). Exact rational weights and residual_rank in allocations govern the largest-remainder allocation; no money is assigned by this conversion alone.", "parameters": { "type": "object", "properties": { "pool_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "pool_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_fx_proceeds_exact_largest_remainder_rights", "service": "px_b_73", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-37", "rule_documents": [ "PX-B-37" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "disburse_allocation": { "definition": { "name": "disburse_allocation", "description": "Pay amount_minor from a converted pool to allocation_id. Bank permits any positive amount within remaining cash; contractual largest-remainder rights must be calculated separately. Transfers are irreversible.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "allocation_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "royalty_payout_capacity_fee_batch_instant_execution", "service": "px_br_royalty_capacity", "portal": "psp", "applicable_entity": "Royalties with a delivery service contract", "interface_document": "PX-BR-ROYALTY-CAPACITY", "rule_documents": [ "PX-BR-ROYALTY-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "prepare_currency_leg": { "definition": { "name": "prepare_currency_leg", "description": "Prepare the named settlement pair's source or counterparty leg. Counterparty readiness comes from its published bank receipt; preparation charges prepare_fee_minor once per attempt, even if unavailable. Enrolled partial PvP schedules allow amount_minor on source preparation, moving that exact principal into a real segregated hold. Counterparty preparation confirms actual capacity asynchronously.", "parameters": { "type": "object", "properties": { "pair_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "leg": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 1, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "pair_id", "leg" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "pvp_partial_exchange_preparation_reverse_leg_capacity_source_cash_finality", "service": "px_br_pvp_preparation", "portal": "psp", "applicable_entity": "Enrolled partial PvP schedules", "interface_document": "PX-BR-PVP-PREPARATION", "rule_documents": [ "PX-BR-PVP-PREPARATION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_currency_pair": { "definition": { "name": "settle_currency_pair", "description": "Settle both currency legs synchronously, requiring both prepared, or release source principal unilaterally. unilateral is legal but creates irreversible principal exposure if the counterparty is unavailable. Fees/principal are published on the pair. A linked currency window must be unexpired and assigned to this exact pair. Enrolled partial PvP schedules allow source_minor for a slice, consuming source hold and actual confirmed reverse capacity; see partial settlement terms.", "parameters": { "type": "object", "properties": { "pair_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "mode": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "source_minor": { "type": "integer", "minimum": 1, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "pair_id", "mode" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "pvp_partial_exchange_preparation_reverse_leg_capacity_source_cash_finality", "service": "px_br_pvp_slices", "portal": "psp", "applicable_entity": "Enrolled partial PvP schedules", "interface_document": "PX-BR-PVP-SLICES", "rule_documents": [ "PX-BR-PVP-SLICES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "release_currency_preparations": { "definition": { "name": "release_currency_preparations", "description": "Release prepared legs on an unsettled pair. Preparation fees are not refunded. Releasing leaves the source principal available for another pair.", "parameters": { "type": "object", "properties": { "pair_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "pair_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "pvp_partial_exchange_preparation_reverse_leg_capacity_source_cash_finality", "service": "px_br_pvp_slices", "portal": "psp", "applicable_entity": "Enrolled partial PvP schedules", "interface_document": "PX-BR-PVP-SLICES", "rule_documents": [ "PX-BR-PVP-SLICES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_fee_correction": { "definition": { "name": "request_fee_correction", "description": "Claim a service-fee correction for fee_id and amount_minor. Only bank-provider overcharges under the published billing record are credited; third-party charges and missed optional coupons are ineligible. Review can legally reject a claim and charges the published review fee. Existing refund_minor occupies the entitlement: a claim above gross overcharge minus previously allocated credits is rejected after its review fee. Enrolled billing review schedules additionally require a previously reserved investigation file covering this exact fee.", "parameters": { "type": "object", "properties": { "fee_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "fee_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "billing_fee_investigation_one_shot_capacity_final_tier_rebate_deadline", "service": "px_br_billing_files", "portal": "psp", "applicable_entity": "Enrolled billing review schedules", "interface_document": "PX-BR-BILLING-FILES", "rule_documents": [ "PX-BR-BILLING-FILES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_tax_agent_application": { "definition": { "name": "submit_tax_agent_application", "description": "Submit customer-uploaded tax-agent appointment for agent_id; approval is published by a bank event after review_delay. Approved agency is distinct from configured payment routing. Before executing submit_tax_agent_application, the customer must call upload_file with target_id equal to the agent_id used in that operation and purpose=\"tax_agent_appointment\". The assistant obtains that business record ID from bank records and supplies it in the upload instruction. A case ID or approval request ID is not the evidence target. Listing a file is not a submission. A matching upload is immediately available to execution; upload alone does not schedule processing, and the submission may be corrected before retrying the same approved request. DOCUMENT_SUBMISSION_REQUIRED means no submission matches both the required target and purpose. DOCUMENT_CONTENT_MISMATCH means matching submissions exist but their contents do not satisfy the published evidence requirements.", "parameters": { "type": "object", "properties": { "agent_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "agent_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "configure_tax_agent_route": { "definition": { "name": "configure_tax_agent_route", "description": "Enable an approved agent for its published jurisdictions. This creates a distinct route; historical recipient identity cannot be overwritten.", "parameters": { "type": "object", "properties": { "agent_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "agent_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_tax_obligation": { "definition": { "name": "pay_tax_obligation", "description": "Pay the full unpaid tax item to recipient_id. The payment network accepts any listed active recipient; product/jurisdiction eligibility and agent appointment must be checked by the caller. Unqualified routing may post cash without discharging the tax obligation.", "parameters": { "type": "object", "properties": { "obligation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "recipient_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "obligation_id", "recipient_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agency_capacity_jurisdiction_receipt_deadline_handover", "service": "px_br_tax_routes", "portal": "psp", "applicable_entity": "Tax handovers with a processing capacity contract", "interface_document": "PX-BR-TAX-ROUTES", "rule_documents": [ "PX-BR-TAX-ROUTES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_tax_overpayment_review": { "definition": { "name": "request_tax_overpayment_review", "description": "Ask the tax authority to review the referenced original payment, with a customer-uploaded overpayment statement. The authority's fixed event determines approved credit, not the bank or the user. Before executing request_tax_overpayment_review, the customer must call upload_file with target_id equal to the claim_id used in that operation and purpose=\"overpayment_statement\". The assistant obtains that business record ID from bank records and supplies it in the upload instruction. A case ID or approval request ID is not the evidence target. Listing a file is not a submission. A matching upload is immediately available to execution; upload alone does not schedule processing, and the submission may be corrected before retrying the same approved request. DOCUMENT_SUBMISSION_REQUIRED means no submission matches both the required target and purpose. DOCUMENT_CONTENT_MISMATCH means matching submissions exist but their contents do not satisfy the published evidence requirements.", "parameters": { "type": "object", "properties": { "claim_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "claim_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_authority_overpayment_credit", "service": "px_b_77", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-102a05700f38", "rule_documents": [ "SUPPLEMENT-102a05700f38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "dispose_tax_credit": { "definition": { "name": "dispose_tax_credit", "description": "Use an authority-approved credit by offsetting the next period or requesting a cash refund. Cash refund is irreversible and arrives only after refund_delay; offset immediately reduces the named next liability. amount_minor cannot exceed approved unused credit. Enrolled consecutive-period schedules require credit_lot_id and accept period_id for offset; actual lot eligibility and cumulative period ceilings apply.", "parameters": { "type": "object", "properties": { "claim_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "mode": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "credit_lot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "period_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "claim_id", "mode", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_credit_lots_period_eligibility_refund_cash_liquidity_appeal_deadline", "service": "px_br_tax_disposition", "portal": "psp", "applicable_entity": "Enrolled consecutive-period overpayment schedules", "interface_document": "PX-BR-TAX-DISPOSITION", "rule_documents": [ "PX-BR-TAX-DISPOSITION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_next_tax_period": { "definition": { "name": "pay_next_tax_period", "description": "Pay the remaining next-period liability in cash after approved offsets. Cash debit cannot use an unreceived requested refund.", "parameters": { "type": "object", "properties": { "period_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "period_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_credit_lots_period_eligibility_refund_cash_liquidity_appeal_deadline", "service": "px_br_tax_disposition", "portal": "psp", "applicable_entity": "Enrolled consecutive-period overpayment schedules", "interface_document": "PX-BR-TAX-DISPOSITION", "rule_documents": [ "PX-BR-TAX-DISPOSITION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "register_customs_refund_account": { "definition": { "name": "register_customs_refund_account", "description": "Register a synthetic customs refund ACH destination for importer_id. The destination must belong to the importer and support ACH; registration creates no refund entitlement.", "parameters": { "type": "object", "properties": { "importer_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "destination_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "importer_id", "destination_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "scoped_synthetic_customs_refund_product", "service": "px_b_78", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-39", "rule_documents": [ "PX-B-39" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_customs_refund_claim": { "definition": { "name": "submit_customs_refund_claim", "description": "Submit distinct entry_ids for the registered importer after uploading the customs schedule. Duplicate IDs are rejected before any filing fee or application. Review excludes ineligible entries according to fixed authority evidence and charges filing_fee_minor, even if the submission is incomplete. Before executing submit_customs_refund_claim, the customer must call upload_file with target_id equal to the importer_id used in that operation and purpose=\"customs_schedule\". The assistant obtains that business record ID from bank records and supplies it in the upload instruction. A case ID or approval request ID is not the evidence target. Listing a file is not a submission. A matching upload is immediately available to execution; upload alone does not schedule processing, and the submission may be corrected before retrying the same approved request. DOCUMENT_SUBMISSION_REQUIRED means no submission matches both the required target and purpose. DOCUMENT_CONTENT_MISMATCH means matching submissions exist but their contents do not satisfy the published evidence requirements.", "parameters": { "type": "object", "properties": { "importer_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "entry_ids": { "type": "array", "items": { "type": "string" }, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "importer_id", "entry_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "scoped_synthetic_customs_refund_product", "service": "px_b_78", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-39", "rule_documents": [ "PX-B-39" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "accept_customs_award": { "definition": { "name": "accept_customs_award", "description": "Accept the authority's reviewed customs award into the registered ACH account, or withdraw it. amount_minor must exactly match the published award in USD minor units. Acceptance transfers only that reviewed total; withdrawal forfeits this claim. A registry lien can make part of credited funds unavailable; a receipt does not extinguish that encumbrance.", "parameters": { "type": "object", "properties": { "importer_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "decision": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "importer_id", "decision", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "initial_and_supplemental_customs_ach_receiving_windows", "service": "px_br_customs_receiving", "portal": "psp", "applicable_entity": "Enrolled customs installment disbursements.", "interface_document": "PX-BR-CUSTOMS-RECEIVING", "rule_documents": [ "PX-BR-CUSTOMS-RECEIVING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "create_bank_evidence": { "definition": { "name": "create_bank_evidence", "description": "Create a signed receipt, signed statement or account certificate for evidence_request_id. field_names selects disclosed fields; statement includes all transactions, receipt only the requested transaction, and certificate proves ownership only. Format must be pdf for a seal. Creation charges the public fee and does not deliver it.", "parameters": { "type": "object", "properties": { "evidence_request_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "kind": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "field_names": { "type": "array", "items": { "type": "string" }, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "format": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "evidence_request_id", "kind", "field_names", "format" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "single_payment_seals_and_bank_advice_versions", "service": "px_br_proof_versions", "portal": "psp", "applicable_entity": "Enrolled preliminary and final payment-proof delivery.", "interface_document": "PX-BR-PROOF-VERSIONS", "rule_documents": [ "PX-BR-PROOF-VERSIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_bank_evidence": { "definition": { "name": "deliver_bank_evidence", "description": "Disclose generated evidence to the request's recipient. Delivery is irreversible; customer consent scope and recipient acceptance must be evaluated before calling.", "parameters": { "type": "object", "properties": { "evidence_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "evidence_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "derived_payment_fields_and_source_attachments", "service": "px_br_proof_lineage", "portal": "psp", "applicable_entity": "Bank receipts rendered for a named recipient under customer consent.", "interface_document": "PX-BR-PROOF-LINEAGE", "rule_documents": [ "PX-BR-PROOF-LINEAGE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "recover_access_channel": { "definition": { "name": "recover_access_channel", "description": "Recover login, contact, or payment credential for profile_id using an actual identity_recovery upload. A review event activates only the selected channel after review_delay and increments its credential version; other channels are unaffected. Before executing recover_access_channel, the customer must call upload_file with target_id equal to the profile_id used in that operation and purpose=\"identity_recovery\". The assistant obtains that business record ID from bank records and supplies it in the upload instruction. A case ID or approval request ID is not the evidence target. Listing a file is not a submission. A matching upload is immediately available to execution; upload alone does not schedule processing, and the submission may be corrected before retrying the same approved request. DOCUMENT_SUBMISSION_REQUIRED means no submission matches both the required target and purpose. DOCUMENT_CONTENT_MISMATCH means matching submissions exist but their contents do not satisfy the published evidence requirements.", "parameters": { "type": "object", "properties": { "profile_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "profile_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "create_payment_challenge": { "definition": { "name": "create_payment_challenge", "description": "Create a payment authentication challenge bound immutably to the current profile credential version and obligation amount. method is registered_email or mobile. The corresponding contact channel must be active. challenge_fee_minor is charged even if later credential recovery makes this challenge stale; expires after challenge_ttl minutes. beneficiary_id is mandatory when a supplier beneficiary record is linked. It binds the authorized routing account in addition to invoice amount and payment credential version.", "parameters": { "type": "object", "properties": { "profile_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "obligation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "method": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "beneficiary_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "profile_id", "obligation_id", "method" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "execute_authenticated_payment": { "definition": { "name": "execute_authenticated_payment", "description": "Execute an unpaid obligation using the active credential_version and matching unexpired challenge_id. The challenge binds obligation, amount and credential version; recovery invalidates old-version challenges. Login/contact reset alone does not activate payment authentication. beneficiary_id is mandatory when a supplier beneficiary record is linked. It binds the authorized routing account in addition to invoice amount and payment credential version.", "parameters": { "type": "object", "properties": { "obligation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "profile_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "credential_version": { "type": "integer", "minimum": 0, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "challenge_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "beneficiary_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "obligation_id", "profile_id", "credential_version", "challenge_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "revoke_access_credential": { "definition": { "name": "revoke_access_credential", "description": "Revoke one credential or all credentials in the same family. Accepted transfer instructions remain separately actionable; revocation blocks future queued submissions but does not recall accepted transfers.", "parameters": { "type": "object", "properties": { "credential_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "scope": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "credential_id", "scope" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident_scope_and_accepted_transfer_boundary", "service": "px_b_82", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-42", "rule_documents": [ "PX-B-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "resolve_queued_transfer": { "definition": { "name": "resolve_queued_transfer", "description": "Cancel or execute an accepted/queued transfer. Cancellation charges its published cancellation fee. Executing queued transfers requires an active credential; already accepted transfers can execute even after credential revocation. A legal transfer can still be unauthorized by the customer.", "parameters": { "type": "object", "properties": { "transfer_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "action": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "transfer_id", "action" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident_scope_and_accepted_transfer_boundary", "service": "px_b_82", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-42", "rule_documents": [ "PX-B-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_delegate_scope_application": { "definition": { "name": "submit_delegate_scope_application", "description": "Submit an actual delegation_letter to enlarge a delegate grant. Fixed review result adds the published requested_permissions after review_delay; no early disclosure is authorized. Before executing submit_delegate_scope_application, the customer must call upload_file with target_id equal to the grant_id used in that operation and purpose=\"delegation_letter\". The assistant obtains that business record ID from bank records and supplies it in the upload instruction. A case ID or approval request ID is not the evidence target. Listing a file is not a submission. A matching upload is immediately available to execution; upload alone does not schedule processing, and the submission may be corrected before retrying the same approved request. DOCUMENT_SUBMISSION_REQUIRED means no submission matches both the required target and purpose. DOCUMENT_CONTENT_MISMATCH means matching submissions exist but their contents do not satisfy the published evidence requirements.", "parameters": { "type": "object", "properties": { "grant_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "grant_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "company_specific_delegation_and_disclosure", "service": "px_b_83", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-90f687a1a494", "rule_documents": [ "SUPPLEMENT-90f687a1a494" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_delegate_data": { "definition": { "name": "deliver_delegate_data", "description": "Deliver selected field_names for business_id to a contact using grant_id. Bank delivery service can disclose any fields in its report catalog; the caller must enforce company-specific current delegation and customer scope. Each disclosure is immutable.", "parameters": { "type": "object", "properties": { "grant_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "business_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "field_names": { "type": "array", "items": { "type": "string" }, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "grant_id", "business_id", "field_names" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "company_specific_delegation_and_disclosure", "service": "px_b_83", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-90f687a1a494", "rule_documents": [ "SUPPLEMENT-90f687a1a494" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "execute_delegated_payment": { "definition": { "name": "execute_delegated_payment", "description": "Pay the managed business obligation under a currently effective company-specific payment grant. Query or submit permission does not grant payment authority. A linked company officer amount limit must cover this business and is consumed once.", "parameters": { "type": "object", "properties": { "grant_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "business_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "grant_id", "business_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "company_specific_delegation_and_disclosure", "service": "px_b_83", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-90f687a1a494", "rule_documents": [ "SUPPLEMENT-90f687a1a494" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "fix_supplier_delivery_terms": { "definition": { "name": "fix_supplier_delivery_terms", "description": "Fix risk terms before paying the linked purchase order. risk_terms describes claim retention or commercial waiver; payment records the selected contract. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_purchase_delivery_protection", "service": "px_b_67", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-4c1d35c3f4ab", "rule_documents": [ "SUPPLEMENT-4c1d35c3f4ab" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "inspect_paid_supplier_shipment": { "definition": { "name": "inspect_paid_supplier_shipment", "description": "Request carrier inspection of the paid order's actual revision. The event publishes missing units; customer assurances do not replace this receipt. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_purchase_delivery_protection", "service": "px_b_67", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-4c1d35c3f4ab", "rule_documents": [ "SUPPLEMENT-4c1d35c3f4ab" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "elect_supplier_shortage_remedy": { "definition": { "name": "elect_supplier_shortage_remedy", "description": "Elect one remedy in remedies after inspection. Replacement requires retained claims and sufficient paid-order protection. A waiver or cash concession can legally forfeit undelivered goods. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_purchase_delivery_protection", "service": "px_b_67", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-4c1d35c3f4ab", "rule_documents": [ "SUPPLEMENT-4c1d35c3f4ab" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "accept_supplier_delivery_result": { "definition": { "name": "accept_supplier_delivery_result", "description": "Accept the original and replacement units actually received. Acceptance is immutable; it may leave a short delivery if claims were waived. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_purchase_delivery_protection", "service": "px_b_67", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-4c1d35c3f4ab", "rule_documents": [ "SUPPLEMENT-4c1d35c3f4ab" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_campaign_launch_capacity": { "definition": { "name": "reserve_campaign_launch_capacity", "description": "Reserve provider capacity against real usable credit in wallet_id; allocation event publishes accepted capacity. Reserving does not itself activate advertising. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "campaign_search_display_capacity_cancellation_advertising_wallet", "service": "px_br_campaign_mix", "portal": "psp", "applicable_entity": "Campaigns with separate channel delivery mandates", "interface_document": "PX-BR-CAMPAIGN-MIX", "rule_documents": [ "PX-BR-CAMPAIGN-MIX" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "release_unserved_campaign_capacity": { "definition": { "name": "release_unserved_campaign_capacity", "description": "Release the portion the provider cannot serve. Original accepted capacity stays reserved, and only released capacity can fund a makegood placement. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "merchant_receipt_and_usable_service_credit", "service": "px_b_68", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-842ca3d63824", "rule_documents": [ "SUPPLEMENT-842ca3d63824" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "book_campaign_makegood": { "definition": { "name": "book_campaign_makegood", "description": "Book released capacity into one listed placement. Placement campaign and booking fee are public; a different campaign consumes credit without advancing this launch. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "campaign_search_display_capacity_cancellation_advertising_wallet", "service": "px_br_campaign_delivery", "portal": "psp", "applicable_entity": "Campaigns with separate channel delivery mandates", "interface_document": "PX-BR-CAMPAIGN-DELIVERY", "rule_documents": [ "PX-BR-CAMPAIGN-DELIVERY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "activate_campaign_launch": { "definition": { "name": "activate_campaign_launch", "description": "Consume the actual booked provider credits and activate the selected campaigns. Original wallet cash cannot be spent a second time; wrong-campaign booking remains a real loss. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "campaign_search_display_capacity_cancellation_advertising_wallet", "service": "px_br_campaign_delivery", "portal": "psp", "applicable_entity": "Campaigns with separate channel delivery mandates", "interface_document": "PX-BR-CAMPAIGN-DELIVERY", "rule_documents": [ "PX-BR-CAMPAIGN-DELIVERY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_store_order_inventory": { "definition": { "name": "reserve_store_order_inventory", "description": "Reserve stock for the linked existing storefront order. Inventory receipt may reveal a short line independently of payment reconciliation. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "gateway_payment_and_merchant_fulfillment_receipt", "service": "px_b_69", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-34", "rule_documents": [ "PX-B-34" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "commit_store_order_substitute": { "definition": { "name": "commit_store_order_substitute", "description": "Commit a listed substitution for unavailable units. Compatibility and fee are public; an incompatible substitute or omission can leave the commercial order unfulfilled. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "gateway_payment_and_merchant_fulfillment_receipt", "service": "px_b_69", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-34", "rule_documents": [ "PX-B-34" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "dispatch_reconciled_store_order": { "definition": { "name": "dispatch_reconciled_store_order", "description": "Dispatch only once the linked merchant order is genuinely paid. Dispatch captures the actual payment component IDs and sends only stocked/substituted units. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "gateway_payment_and_merchant_fulfillment_receipt", "service": "px_b_69", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-34", "rule_documents": [ "PX-B-34" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "close_store_delivery_receipt": { "definition": { "name": "close_store_delivery_receipt", "description": "Close fulfillment against the carrier receipt and the reconciled merchant account. This does not create or replay a customer charge. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "gateway_payment_and_merchant_fulfillment_receipt", "service": "px_b_69", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-34", "rule_documents": [ "PX-B-34" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "register_platform_revenue_reconciliation": { "definition": { "name": "register_platform_revenue_reconciliation", "description": "Register reconciliation of the selected platform receiving account. Its first accepted-payout settlement posts the published reserve hold from actual proceeds; Other platform rules are separate. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_auto_payout_control_boundary", "service": "px_b_70", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-35", "rule_documents": [ "PX-B-35" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_platform_reserve_breakdown": { "definition": { "name": "request_platform_reserve_breakdown", "description": "Request the platform's fixed reserve breakdown after a real hold has posted. The event identifies disputed and undisputed amounts. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_auto_payout_control_boundary", "service": "px_b_70", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-35", "rule_documents": [ "PX-B-35" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "dispose_platform_revenue_reserve": { "definition": { "name": "dispose_platform_revenue_reserve", "description": "Choose evidence_appeal, waive_disputed or forfeit_all. Appeal uses the published existing settlement evidence and fee; waiver/forfeiture legally surrenders retained proceeds. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_auto_payout_control_boundary", "service": "px_b_70", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-35", "rule_documents": [ "PX-B-35" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_manual_platform_receipt": { "definition": { "name": "settle_manual_platform_receipt", "description": "Settle the genuine pending manual receipt in this record. Requires the receiving account to remain active; does not enable any automatic payout rule. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_payment_discontinuation", "service": "px_b_r70_exit", "portal": "psp", "applicable_entity": "Platform receiving accounts with pending customer returns and manual receipts", "interface_document": "PX-B-R35-EXIT", "rule_documents": [ "PX-B-R35-EXIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "register_export_invoice_allocation": { "definition": { "name": "register_export_invoice_allocation", "description": "Register the invoice issuer for the unsettled lot. invoice_entities lists transport-supported entities; the exporter and customs allocation still govern reporting rights. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_withdrawal_and_declaration_entitlement", "service": "px_b_71", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-211a88fde08d", "rule_documents": [ "SUPPLEMENT-211a88fde08d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "review_export_customs_allocation": { "definition": { "name": "review_export_customs_allocation", "description": "Ask customs to publish the reportable portion of gross settlement; an adjustment portion can settle as cash without becoming reportable export value. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_withdrawal_and_declaration_entitlement", "service": "px_b_71", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-211a88fde08d", "rule_documents": [ "SUPPLEMENT-211a88fde08d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "fix_export_declaration_basis": { "definition": { "name": "fix_export_declaration_basis", "description": "Before settlement, elect the monetary declaration basis within gross lot value. The bank accepts a self-declared value; the caller is responsible for matching customs evidence and issuer. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "record_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_withdrawal_and_declaration_entitlement", "service": "px_b_71", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-211a88fde08d", "rule_documents": [ "SUPPLEMENT-211a88fde08d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_export_reporting_package": { "definition": { "name": "submit_export_reporting_package", "description": "Submit the issued declaration with the basis fixed before settlement, or a settled ordinary-cash record reporting zero declaration rights. Gross cash conversion and reportable invoice value are separate quantities. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_withdrawal_and_declaration_entitlement", "service": "px_b_71", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-211a88fde08d", "rule_documents": [ "SUPPLEMENT-211a88fde08d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_supplier_credit_advice": { "definition": { "name": "request_supplier_credit_advice", "description": "Request the supplier's amended-invoice credit advice. The fixed event can arrive while an older FX cancellation is pending and change the underlying currency requirement. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "conditional_fx_cancellation_and_remaining_exposure", "service": "px_b_72", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-36", "rule_documents": [ "PX-B-36" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "allocate_supplier_invoice_credit": { "definition": { "name": "allocate_supplier_invoice_credit", "description": "Choose invoice_netting, cash_refund, contract_credit or settlement_discount for the confirmed credit. Netting reduces this invoice's payable; a cash refund leaves the gross payment due and returns credit less refund_fee_minor after refund_delay. Contract credit retains it against the separately listed future contract; a settlement discount surrenders it as a commercial concession. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "conditional_fx_cancellation_and_remaining_exposure", "service": "px_b_72", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-36", "rule_documents": [ "PX-B-36" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "sell_surplus_supplier_currency": { "definition": { "name": "sell_surplus_supplier_currency", "description": "Sell held target currency before supplier payment using a public sale_routes quote. Reduces acquired currency, credits actual net sale proceeds, and cannot reverse an already executed supplier payment. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "amount_minor", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "conditional_fx_cancellation_and_remaining_exposure", "service": "px_b_72", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-36", "rule_documents": [ "PX-B-36" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "confirm_supplier_fx_settlement": { "definition": { "name": "confirm_supplier_fx_settlement", "description": "Confirm the paid revised invoice and actual unspent currency. Does not conceal surplus or repair an incorrect credit allocation. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_fx_installment_credit_refund_partial_fill_exposure", "service": "px_br_fx_exposure", "portal": "psp", "applicable_entity": "Supplier invoices with an installment schedule", "interface_document": "PX-BR-FX-EXPOSURE", "rule_documents": [ "PX-BR-FX-EXPOSURE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "review_royalty_beneficiary_residency": { "definition": { "name": "review_royalty_beneficiary_residency", "description": "Publish residency-dependent withholding for the named beneficiary. Contractual gross shares still follow the original largest-remainder rule. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_fx_proceeds_exact_largest_remainder_rights", "service": "px_b_73", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-37", "rule_documents": [ "PX-B-37" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "elect_royalty_withholding": { "definition": { "name": "elect_royalty_withholding", "description": "Elect tax amount and attribution using choice as an actual allocation ID from the same pool. The bank can accept declarations, but withheld tax belongs to the actual liable beneficiary and reduces that beneficiary's net cash. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "record_id", "choice", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_fx_proceeds_exact_largest_remainder_rights", "service": "px_b_73", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-37", "rule_documents": [ "PX-B-37" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "remit_royalty_withholding": { "definition": { "name": "remit_royalty_withholding", "description": "Remit elected withholding from the same converted pool used for net beneficiary distributions. The same minor unit cannot be paid to a beneficiary and tax authority. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_fx_proceeds_exact_largest_remainder_rights", "service": "px_b_73", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-37", "rule_documents": [ "PX-B-37" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_royalty_tax_certificate": { "definition": { "name": "deliver_royalty_tax_certificate", "description": "Deliver the actual beneficiary/tax attribution after distribution. A certificate cannot retroactively repair money attributed to another beneficiary. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "shared_fx_proceeds_exact_largest_remainder_rights", "service": "px_b_73", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-37", "rule_documents": [ "PX-B-37" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "book_currency_settlement_window": { "definition": { "name": "book_currency_settlement_window", "description": "Book a published settlement window and its fee. A counterparty capacity event may withdraw readiness of a shortlisted pair before principal is committed. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_payment_versus_payment_settlement", "service": "px_b_74", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3e345e510e32", "rule_documents": [ "SUPPLEMENT-3e345e510e32" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "assign_currency_window_pair": { "definition": { "name": "assign_currency_window_pair", "description": "Assign one observed pair to the effective window. Pair selection controls which original prepare/settle operations can use the window; published principal and target amounts remain authoritative. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_payment_versus_payment_settlement", "service": "px_b_74", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3e345e510e32", "rule_documents": [ "SUPPLEMENT-3e345e510e32" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "confirm_currency_settlement_finality": { "definition": { "name": "confirm_currency_settlement_finality", "description": "Confirm actual received target currency and the committed pair after settlement. Does not reverse unsecured release or expired execution. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "pvp_partial_exchange_preparation_reverse_leg_capacity_source_cash_finality", "service": "px_br_pvp_finality", "portal": "psp", "applicable_entity": "Enrolled partial PvP schedules", "interface_document": "PX-BR-PVP-FINALITY", "rule_documents": [ "PX-BR-PVP-FINALITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "trace_previously_posted_fee_rebate": { "definition": { "name": "trace_previously_posted_fee_rebate", "description": "Trace an existing bank rebate in the original journal, charging trace_fee_minor. The result publishes amount and original billing reference; it is not a new cash credit. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "retrospective_fee_correction_and_tier_basis", "service": "px_b_75", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-e4da1f326856", "rule_documents": [ "SUPPLEMENT-e4da1f326856" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "allocate_existing_fee_rebate": { "definition": { "name": "allocate_existing_fee_rebate", "description": "Allocate located rebate occupancy to a bank billing record. choice is a billing ID. Subsequent fee corrections deduct existing refund_minor, so reference attribution changes the amount still claimable. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "retrospective_fee_correction_and_tier_basis", "service": "px_b_75", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-e4da1f326856", "rule_documents": [ "SUPPLEMENT-e4da1f326856" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "issue_fee_recovery_statement": { "definition": { "name": "issue_fee_recovery_statement", "description": "Issue a company statement of actual bank fee credits after all pending bases finalize. It includes original rebates and newly posted corrections without double-counting. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "retrospective_fee_correction_and_tier_basis", "service": "px_b_75", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-e4da1f326856", "rule_documents": [ "SUPPLEMENT-e4da1f326856" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_fee_recovery_statement": { "definition": { "name": "deliver_fee_recovery_statement", "description": "Deliver the credit statement to a company_destinations address. Listed contacts can belong to separate entities; delivery is irreversible. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "retrospective_fee_correction_and_tier_basis", "service": "px_b_75", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-e4da1f326856", "rule_documents": [ "SUPPLEMENT-e4da1f326856" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "appeal_unapproved_tax_balance": { "definition": { "name": "appeal_unapproved_tax_balance", "description": "Appeal only after the original authority review. appeal_channels publishes cost/delay; confirmed additional credit becomes part of the same claim and can fund the next period before its deadline. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_authority_overpayment_credit", "service": "px_b_77", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-102a05700f38", "rule_documents": [ "SUPPLEMENT-102a05700f38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_next_tax_clearance_notice": { "definition": { "name": "request_next_tax_clearance_notice", "description": "Request authority clearance after actual cash plus offsets discharge the next period. The event publishes the credited components and period identity. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_authority_overpayment_credit", "service": "px_b_77", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-102a05700f38", "rule_documents": [ "SUPPLEMENT-102a05700f38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "acknowledge_tax_clearance_reference": { "definition": { "name": "acknowledge_tax_clearance_reference", "description": "Acknowledge an authority notice reference from notice_references. References may concern different periods; the customer needs clearance of this paid period. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_authority_overpayment_credit", "service": "px_b_77", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-102a05700f38", "rule_documents": [ "SUPPLEMENT-102a05700f38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "inspect_importer_customs_lien": { "definition": { "name": "inspect_importer_customs_lien", "description": "Inspect registry encumbrances on the importer's duty award. An eligible refund can remain legally encumbered even when credited to the correct ACH account. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "scoped_synthetic_customs_refund_product", "service": "px_b_78", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-39", "rule_documents": [ "PX-B-39" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "file_customs_lien_discharge": { "definition": { "name": "file_customs_lien_discharge", "description": "File one registry-issued release certificate. release_certificates publishes covered entry, amount and fee; similarly named certificates can cover different duty entries. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "scoped_synthetic_customs_refund_product", "service": "px_b_78", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-39", "rule_documents": [ "PX-B-39" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "apply_customs_encumbrance_release": { "definition": { "name": "apply_customs_encumbrance_release", "description": "Apply the registry's actual discharge to the matching entry lien. An unrelated certificate is legally filed but releases no encumbrance on this award. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "scoped_synthetic_customs_refund_product", "service": "px_b_78", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-39", "rule_documents": [ "PX-B-39" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_customs_availability_statement": { "definition": { "name": "deliver_customs_availability_statement", "description": "Deliver the award's received amount and outstanding legal encumbrance after ACH receipt. The statement cannot erase an unreleased lien. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "scoped_synthetic_customs_refund_product", "service": "px_b_78", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-39", "rule_documents": [ "PX-B-39" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_buyer_invoice_requirements": { "definition": { "name": "request_buyer_invoice_requirements", "description": "Retrieve the buyer's signed billing-address requirement before issuing replacement service-fee invoices. The requirement and current company master data can differ. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "net_service_fee_invoices_and_replacement", "service": "px_b_79", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3a93c1f5bafd", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "update_company_invoice_address": { "definition": { "name": "update_company_invoice_address", "description": "Select a registered company address ID and increment the original invoice profile's address version. Already issued invoices retain the old address; changing master data does not rewrite them. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "net_service_fee_invoices_and_replacement", "service": "px_b_79", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3a93c1f5bafd", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "bind_company_invoice_delivery": { "definition": { "name": "bind_company_invoice_delivery", "description": "Bind invoice delivery to a listed delivery route. Separate company contacts can share a directory; the route determines the receiving entity. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "net_service_fee_invoices_and_replacement", "service": "px_b_79", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3a93c1f5bafd", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "obtain_buyer_invoice_acknowledgement": { "definition": { "name": "obtain_buyer_invoice_acknowledgement", "description": "Obtain the buyer's acceptance or rejection based on the actual delivered invoice address and receiving entity. Existing fee occupancy and replacement costs remain in force. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "net_service_fee_invoices_and_replacement", "service": "px_b_79", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-3a93c1f5bafd", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "verify_bank_proof_recipient": { "definition": { "name": "verify_bank_proof_recipient", "description": "Verify the recipient through one listed channel, paying its fee. The signed receipt may add fields that the buyer needs; it does not expand customer disclosure consent. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "minimum_disclosure_bank_evidence", "service": "px_b_80", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-40", "rule_documents": [ "PX-B-40" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "set_bank_proof_access_scope": { "definition": { "name": "set_bank_proof_access_scope", "description": "Choose a reader policy from access_policies. The transport can support public/team/named readers; only customer-approved recipients may receive this payment proof. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "minimum_disclosure_bank_evidence", "service": "px_b_80", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-40", "rule_documents": [ "PX-B-40" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "issue_scoped_bank_proof_link": { "definition": { "name": "issue_scoped_bank_proof_link", "description": "Issue an access link to an actually delivered bank evidence ID. Its immutable fields and reader policy apply until revoked; the recipient read arrives as an event. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "minimum_disclosure_bank_evidence", "service": "px_b_80", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-40", "rule_documents": [ "PX-B-40" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "revoke_delivered_bank_proof_link": { "definition": { "name": "revoke_delivered_bank_proof_link", "description": "Revoke the temporary link after the genuine recipient receipt. This closes future access without pretending to undo information already disclosed. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "minimum_disclosure_bank_evidence", "service": "px_b_80", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-40", "rule_documents": [ "PX-B-40" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "freeze_independent_standing_payment": { "definition": { "name": "freeze_independent_standing_payment", "description": "Freeze the separately authorized recurring payment before its next due event. Revoking an API credential does not revoke this bank-side standing authority. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident_scope_and_accepted_transfer_boundary", "service": "px_b_82", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-42", "rule_documents": [ "PX-B-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "audit_payment_callback_destination": { "definition": { "name": "audit_payment_callback_destination", "description": "Inspect the actual callback endpoint used by the compromised integration; its result distinguishes similarly named supplier and integration endpoints. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident_scope_and_accepted_transfer_boundary", "service": "px_b_82", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-42", "rule_documents": [ "PX-B-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "rotate_supplier_payment_callback": { "definition": { "name": "rotate_supplier_payment_callback", "description": "Rotate the callback credential and bind one callback_endpoints ID. Existing API-family revocation does not change this independent credential, and choosing another entity can leak payment confirmation. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident_scope_and_accepted_transfer_boundary", "service": "px_b_82", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-42", "rule_documents": [ "PX-B-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "cancel_independent_standing_payment": { "definition": { "name": "cancel_independent_standing_payment", "description": "Cancel the active/frozen standing authority permanently. Frozen authority remains potentially resumable until cancelled; previously accepted transfers remain separately actionable. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident_scope_and_accepted_transfer_boundary", "service": "px_b_82", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-42", "rule_documents": [ "PX-B-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_supplier_payment_callback": { "definition": { "name": "deliver_supplier_payment_callback", "description": "Deliver the actual legitimate payment confirmation through the rotated callback endpoint. The destination entity is fixed by the endpoint, not by a familiar display name. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident_scope_and_accepted_transfer_boundary", "service": "px_b_82", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-42", "rule_documents": [ "PX-B-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_company_officer_countersign": { "definition": { "name": "request_company_officer_countersign", "description": "Request a company officer acknowledgement through an officer_channels entry. Delegation review and an officer's payment limit are distinct company-specific authorizations. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "company_specific_delegation_and_disclosure", "service": "px_b_83", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-90f687a1a494", "rule_documents": [ "SUPPLEMENT-90f687a1a494" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "set_temporary_delegate_payment_limit": { "definition": { "name": "set_temporary_delegate_payment_limit", "description": "Set an amount limit under the actually acknowledged business identity. The original delegated payment consumes this limit; query/submit permissions alone cannot fund it. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "record_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "company_specific_delegation_and_disclosure", "service": "px_b_83", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-90f687a1a494", "rule_documents": [ "SUPPLEMENT-90f687a1a494" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "open_delegate_report_session": { "definition": { "name": "open_delegate_report_session", "description": "Open a temporary report session for one report_audiences scope. The existing field grants still apply independently to each delivered business. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "choice": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "record_id", "choice" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "company_specific_delegation_and_disclosure", "service": "px_b_83", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-90f687a1a494", "rule_documents": [ "SUPPLEMENT-90f687a1a494" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "expire_temporary_delegate_authority": { "definition": { "name": "expire_temporary_delegate_authority", "description": "Expire the added temporary permissions and report session after the authorized payment consumes its limit. Existing baseline permissions remain available. record_id identifies the named public business record. Amounts are integer USD minor units unless the record names a target currency.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "record_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "company_specific_delegation_and_disclosure", "service": "px_b_83", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "SUPPLEMENT-90f687a1a494", "rule_documents": [ "SUPPLEMENT-90f687a1a494" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_retiring_tax_agent_census": { "definition": { "name": "request_retiring_tax_agent_census", "description": "Ask the retiring tax agent for bank-accepted versus queued instructions. The delayed bank census reports actual acceptance and the immutable authority receipt allocation.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handover_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "cancel_unaccepted_tax_instruction": { "definition": { "name": "cancel_unaccepted_tax_instruction", "description": "Cancel a retiring-agent instruction that is not yet bank accepted. An accepted instruction must settle and cannot be cancelled here. instruction_id is from the census.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "instruction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handover_id", "instruction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "end_retiring_tax_agent_mandate": { "definition": { "name": "end_retiring_tax_agent_mandate", "description": "End the named jurisdiction scope of the retiring agent. Select ALL for all its listed jurisdictions. This prevents future submissions, without cancelling instructions already accepted by the bank.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "jurisdiction": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "handover_id", "jurisdiction" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "withdraw_pending_tax_agent_application": { "definition": { "name": "withdraw_pending_tax_agent_application", "description": "Withdraw the new agent application before approval. The later review response records withdrawal rather than creating authority. Existing authority recipients remain usable; the withdrawal service fee is charged once.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "agent_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handover_id", "agent_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "allocate_settled_tax_receipt": { "definition": { "name": "allocate_settled_tax_receipt", "description": "Allocate an amount of a settled retiring-agent receipt to one original tax obligation. This is a bookkeeping instruction: allocation cannot exceed unallocated cash or the unpaid item. The authority receipt jurisdiction still determines which debt the payment really discharged.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "receipt_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "obligation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "handover_id", "receipt_id", "obligation_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "publish_tax_handover_clearance": { "definition": { "name": "publish_tax_handover_clearance", "description": "Publish the two original liabilities, actual predecessor cash receipts, new payments and remaining agent scopes. Publication cannot repair a wrong receipt allocation or duplicate predecessor payment.", "parameters": { "type": "object", "properties": { "handover_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handover_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agent_review_routing_and_jurisdiction", "service": "px_b_76", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-38", "rule_documents": [ "PX-B-38" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "select_recovered_payment_executor": { "definition": { "name": "select_recovered_payment_executor", "description": "Select an execution desk after the recovery provider publishes its actual staff availability. A desk may have preparation-only authority. Selection pays its public fee and schedules handover after its delay; bank selection itself does not certify the commercial execution mandate.", "parameters": { "type": "object", "properties": { "handoff_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "desk_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handoff_id", "desk_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "migrate_recovery_payment_instruction": { "definition": { "name": "migrate_recovery_payment_instruction", "description": "Migrate one held original payment instruction to the current payment credential version, preserving its commercial identity and amount. An instruction for another quote remains another quote. A previously retired instruction is unavailable.", "parameters": { "type": "object", "properties": { "handoff_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "instruction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handoff_id", "instruction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "replace_recovery_payment_instruction": { "definition": { "name": "replace_recovery_payment_instruction", "description": "Retire a held instruction and create a new immutable instruction for the same obligation and amount under the recovered credential. The public replacement fee is charged. It does not expand the selected executor authority.", "parameters": { "type": "object", "properties": { "handoff_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "instruction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handoff_id", "instruction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "bind_recovered_payment_instruction": { "definition": { "name": "bind_recovered_payment_instruction", "description": "Bind one ready instruction to payment execution. The bank keeps its exact obligation, amount and credential version; selecting a different instruction does not amend its contents.", "parameters": { "type": "object", "properties": { "handoff_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "instruction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handoff_id", "instruction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "complete_recovery_execution_handover": { "definition": { "name": "complete_recovery_execution_handover", "description": "Close temporary execution access after the supplier payment. This removes the selected temporary desk while preserving the restored owner payment channel and immutable used instruction.", "parameters": { "type": "object", "properties": { "handoff_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "handoff_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_login_contact_and_payment_recovery", "service": "px_b_81", "portal": "psp", "applicable_entity": "Only the named synthetic benchmark product and its published customer records; no claim of real law or present provider availability.", "interface_document": "PX-B-41", "rule_documents": [ "PX-B-41" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_royalty_payout_capacity": { "definition": { "name": "reserve_royalty_payout_capacity", "description": "Reserve a delivery route for one beneficiary allocation. The public service fee is immediately debited. channel_id specifies the service and shared capacity_group; all services in that group consume the same finite instruction slots. Batch channels additionally cap the total net amount submitted. Reservation is not payment or confirmation of final beneficiary eligibility.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "allocation_id", "channel_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "royalty_payout_capacity_fee_batch_instant_execution", "service": "px_br_royalty_capacity", "portal": "psp", "applicable_entity": "Royalties with a delivery service contract", "interface_document": "PX-BR-ROYALTY-CAPACITY", "rule_documents": [ "PX-BR-ROYALTY-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "cancel_unused_royalty_capacity": { "definition": { "name": "cancel_unused_royalty_capacity", "description": "Release one unused payout reservation. Its service fee is not refunded. Submitted instructions still consume the shared execution slot and cannot be erased by cancellation.", "parameters": { "type": "object", "properties": { "booking_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "booking_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "royalty_settlement", "service": "capacity_release", "portal": "psp", "applicable_entity": "royalty capacity reservation", "interface_document": "IFACE-ROYALTY-CAPACITY", "rule_documents": [ "PX-B-37", "IFACE-ROYALTY-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "select_royalty_payout_booking": { "definition": { "name": "select_royalty_payout_booking", "description": "Select an unsubmitted capacity booking for the next disburse_allocation instruction of its beneficiary. Selection does not change the beneficiary, monetary amount, channel rules or delivery deadline.", "parameters": { "type": "object", "properties": { "booking_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "booking_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "royalty_payout_capacity_fee_batch_instant_execution", "service": "px_br_royalty_capacity", "portal": "psp", "applicable_entity": "Royalties with a delivery service contract", "interface_document": "PX-BR-ROYALTY-CAPACITY", "rule_documents": [ "PX-BR-ROYALTY-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "release_accepted_supplier_advance": { "definition": { "name": "release_accepted_supplier_advance", "description": "Release one of the alternative pre-accepted supplier advances. This bank-accepted instruction predates the lost credential and remains executable during recovery. It reserves its nominal cash until the scheduled settlement and charges its own fee. The supplier may credit only the public bounded range; excess reserved principal is released. Both options belong to the same original invoice, so only one alternative is released.", "parameters": { "type": "object", "properties": { "advance_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "advance_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_recovery", "service": "supplier_advance", "portal": "psp", "applicable_entity": "accepted supplier advance", "interface_document": "IFACE-RECOVERY-SUPPLIER-ADVANCE", "rule_documents": [ "PX-B-41", "PX-BR-RECOVERY-ADVANCE", "IFACE-RECOVERY-SUPPLIER-ADVANCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "apply_supplier_advance_receipt": { "definition": { "name": "apply_supplier_advance_receipt", "description": "Apply one actual settled advance to the original supplier invoice. Only received principal reduces the remaining invoice; a reserved amount or service charge is not supplier payment. This does not rewrite the amount in an earlier held instruction or authentication challenge.", "parameters": { "type": "object", "properties": { "advance_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "advance_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "recovery_balance_amendment_instruction_challenge_binding", "service": "px_br_recovery_instructions", "portal": "psp", "applicable_entity": "Supplier recovery contracts with an accepted-advance schedule", "interface_document": "PX-BR-RECOVERY-INSTRUCTIONS", "rule_documents": [ "PX-BR-RECOVERY-INSTRUCTIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "amend_held_supplier_balance": { "definition": { "name": "amend_held_supplier_balance", "description": "Revise a held instruction to the original invoice’s presently outstanding amount, after applying actual supplier advance receipts. This preserves the obligation and old credential epoch; migrate or replace still establishes a current execution instruction. Existing challenges keep their original amounts.", "parameters": { "type": "object", "properties": { "instruction_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "instruction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "recovery_balance_amendment_instruction_challenge_binding", "service": "px_br_recovery_instructions", "portal": "psp", "applicable_entity": "Supplier recovery contracts with an accepted-advance schedule", "interface_document": "PX-BR-RECOVERY-INSTRUCTIONS", "rule_documents": [ "PX-BR-RECOVERY-INSTRUCTIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_tax_agency_processing": { "definition": { "name": "reserve_tax_agency_processing", "description": "Buy agency processing capacity for one jurisdiction before the public booking cutoff. Pending agent approval does not prevent a reservation. Capacity is denominated in tax principal, shares the contract limit across jurisdictions, and charges a nonrefundable reservation fee. It neither pays tax nor creates a tax credit.", "parameters": { "type": "object", "properties": { "capacity_contract_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "jurisdiction": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 1, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "capacity_contract_id", "jurisdiction", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agency", "service": "processing_capacity", "portal": "psp", "applicable_entity": "tax capacity contract", "interface_document": "IFACE-TAX-AGENCY-CAPACITY", "rule_documents": [ "PX-B-38", "PX-BR-TAX-CAPACITY", "IFACE-TAX-AGENCY-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "transfer_unused_tax_agency_capacity": { "definition": { "name": "transfer_unused_tax_agency_capacity", "description": "Move unused reserved processing principal between the contract jurisdictions before its transfer cutoff. Used capacity cannot be transferred. The amendment charge is real cash and the total agency limit is unchanged.", "parameters": { "type": "object", "properties": { "booking_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "jurisdiction": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 1, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "booking_id", "jurisdiction", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "tax_agency", "service": "processing_capacity", "portal": "psp", "applicable_entity": "tax capacity contract", "interface_document": "IFACE-TAX-AGENCY-CAPACITY", "rule_documents": [ "PX-B-38", "PX-BR-TAX-CAPACITY", "IFACE-TAX-AGENCY-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "commit_campaign_allocation_offer": { "definition": { "name": "commit_campaign_allocation_offer", "description": "Commit one advertised allocation offer for the original Summer launch. The service reservation fee is paid now; the subsequent original capacity request publishes actual accepted channel amounts within the offer ranges. The offer is not a promise that every channel’s customer minimum is satisfied.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "offer_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "schedule_id", "offer_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "campaign_capacity", "service": "provider_allocation", "portal": "psp", "applicable_entity": "campaign schedule", "interface_document": "IFACE-CAMPAIGN-CAPACITY", "rule_documents": [ "SUPPLEMENT-842ca3d63824", "PX-BR-CAMPAIGN-MIX", "PX-BR-CAMPAIGN-DELIVERY", "IFACE-CAMPAIGN-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "cancel_accepted_campaign_channel": { "definition": { "name": "cancel_accepted_campaign_channel", "description": "Cancel unactivated accepted capacity from one channel. The contract cancellation percentage is lost from actual prepaid wallet credit; the remaining capacity becomes reusable. This cannot recall advertising already activated.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "amount_minor": { "type": "integer", "minimum": 1, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "schedule_id", "channel", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "campaign_capacity", "service": "provider_allocation", "portal": "psp", "applicable_entity": "campaign schedule", "interface_document": "IFACE-CAMPAIGN-CAPACITY", "rule_documents": [ "SUPPLEMENT-842ca3d63824", "PX-BR-CAMPAIGN-MIX", "PX-BR-CAMPAIGN-DELIVERY", "IFACE-CAMPAIGN-CAPACITY" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_supplier_foreign_installment": { "definition": { "name": "pay_supplier_foreign_installment", "description": "Pay a positive part of the same supplier invoice from actual acquired foreign currency. It reduces both held currency and the remaining original invoice, and cannot be recalled. It does not cancel a still-open FX order or anticipate unconfirmed supplier credit.", "parameters": { "type": "object", "properties": { "requirement_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "requirement_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_fx_installment_credit_refund_partial_fill_exposure", "service": "px_br_fx_installments", "portal": "psp", "applicable_entity": "Supplier invoices with an installment schedule", "interface_document": "PX-BR-FX-INSTALLMENTS", "rule_documents": [ "PX-BR-FX-INSTALLMENTS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "allocate_supplier_credit_portions": { "definition": { "name": "allocate_supplier_credit_portions", "description": "Apportion confirmed supplier credit between invoice offset and cash refund. Their sum must equal the actual credit advice. Offset cannot exceed this invoice’s remaining unpaid principal after actual installments. Cash refund has the published delay and one refund fee; neither a future-contract credit nor a concession satisfies these two dispositions.", "parameters": { "type": "object", "properties": { "credit_record_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "offset_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "refund_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "credit_record_id", "offset_minor", "refund_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_fx_installment_credit_refund_partial_fill_exposure", "service": "px_br_fx_credit_portions", "portal": "psp", "applicable_entity": "Supplier invoices with an installment schedule", "interface_document": "PX-BR-FX-CREDIT-PORTIONS", "rule_documents": [ "PX-BR-FX-CREDIT-PORTIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_export_reporting_capacity": { "definition": { "name": "reserve_export_reporting_capacity", "description": "Reserve amount_minor of one published certificate for a named export lot. Reservations are irrevocable, consume the certificate’s shared capacity across all its lots and charge its fee. The lot may use only its own matured reserved capacity. A reservation is reporting eligibility, not settlement cash or an issued declaration.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "lot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "certificate_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 1, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "schedule_id", "lot_id", "certificate_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "export_shipment_certificate_pooled_capacity_customs_allocation_deadlines", "service": "px_br_export_certificates", "portal": "psp", "applicable_entity": "Enrolled multi-shipment export schedules", "interface_document": "PX-BR-EXPORT-CERTIFICATES", "rule_documents": [ "PX-BR-EXPORT-CERTIFICATES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "issue_fee_invoice_credit_note": { "definition": { "name": "issue_fee_invoice_credit_note", "description": "Issue and deliver a negative adjustment tied to one line of a delivered original fee invoice. It does not free that line’s invoice occupancy. The transport service accepts an amount within the original line, charges the public note fee, and snapshots actual buyer acceptance. The refund and line identity still determine whether the note is economically justified; another fee’s refund is not interchangeable.", "parameters": { "type": "object", "properties": { "invoice_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "fee_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "amount_minor": { "type": "integer", "minimum": 1, "description": "Use integer minor currency units derived from the current obligation and the published business rules." } }, "required": [ "invoice_id", "fee_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "fee_billing", "service": "invoice_adjustment", "portal": "psp", "applicable_entity": "fee invoice", "interface_document": "IFACE-FEE-INVOICE-CREDIT", "rule_documents": [ "SUPPLEMENT-3a93c1f5bafd", "IFACE-FEE-INVOICE-CREDIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_fee_investigation": { "definition": { "name": "reserve_fee_investigation", "description": "Open one paid investigation file through channel_id for actual fee_ids. Published eligibility, per-file line capacity, units and fee apply. This irreversibly reserves shared current-cycle review units but does not request any refund or alter fee basis.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "fee_ids": { "type": "array", "items": { "type": "string" }, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "schedule_id", "channel_id", "fee_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "billing_fee_investigation_one_shot_capacity_final_tier_rebate_deadline", "service": "px_br_billing_files", "portal": "psp", "applicable_entity": "Enrolled billing review schedules", "interface_document": "PX-BR-BILLING-FILES", "rule_documents": [ "PX-BR-BILLING-FILES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "send_incident_supplier_replacement": { "definition": { "name": "send_incident_supplier_replacement", "description": "Submit an independent replacement for the original supplier invoice using an active credential. regular and priority have public fees and settlement delays. An in-flight original is not cancelled by this new transfer and can still settle, creating duplicate supplier delivery. The principal is reserved until its actual delivery event.", "parameters": { "type": "object", "properties": { "incident_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "credential_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "service": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "incident_id", "credential_id", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "credential_incident", "service": "supplier_replacement", "portal": "psp", "applicable_entity": "credential incident", "interface_document": "IFACE-INCIDENT-SUPPLIER-REPLACEMENT", "rule_documents": [ "PX-B-42", "PX-BR-INCIDENT-CONTINUITY", "IFACE-INCIDENT-SUPPLIER-REPLACEMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "deliver_projected_delegate_transactions": { "definition": { "name": "deliver_projected_delegate_transactions", "description": "Permanently deliver selected transaction columns for one company, stamped with an explicit authority_revision. This is a transport operation and permits any catalog columns; company, effective grant revision, column authorization and customer minimum disclosure remain the caller responsibility. A later grant change does not authorize earlier disclosure.", "parameters": { "type": "object", "properties": { "grant_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "business_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "column_names": { "type": "array", "items": { "type": "string" }, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." }, "authority_revision": { "type": "integer", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "grant_id", "business_id", "column_names", "authority_revision" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "minimum_transaction_projections_and_immutable_disclosure_scope", "service": "px_br_delegate_projections", "portal": "psp", "applicable_entity": "Synthetic current-customer incident or delegation records with reasoning_version b-reasoning-1.", "interface_document": "PX-BR-DELEGATE-PROJECTIONS", "rule_documents": [ "PX-BR-DELEGATE-PROJECTIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_customs_classification_review": { "definition": { "name": "submit_customs_classification_review", "description": "Submit the existing classification correction for a reviewed entry owned by the importer. Requires the genuine classification_amendment for that entry; pays the published review-channel fee. Review can confirm additional eligible duty, including zero; filing is not approval.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "entry_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "schedule_id", "entry_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "entry_classification_correction_and_award_installments", "service": "px_br_customs_correction", "portal": "psp", "applicable_entity": "Enrolled importer-owned customs awards with a corrected entry schedule.", "interface_document": "PX-BR-CUSTOMS-CORRECTION", "rule_documents": [ "PX-BR-CUSTOMS-CORRECTION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "select_customs_disbursement_channel": { "definition": { "name": "select_customs_disbursement_channel", "description": "Select a published importer-owned ACH disbursement channel for the next confirmed award balance. Channel fee and cash delay apply when accepting that payout. Original and supplemental amounts can use different published channels; already accepted payouts cannot be recalled.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "schedule_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "initial_and_supplemental_customs_ach_receiving_windows", "service": "px_br_customs_receiving", "portal": "psp", "applicable_entity": "Enrolled customs installment disbursements.", "interface_document": "PX-BR-CUSTOMS-RECEIVING", "rule_documents": [ "PX-BR-CUSTOMS-RECEIVING" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "purchase_payment_proof_seal": { "definition": { "name": "purchase_payment_proof_seal", "description": "Purchase a bank proof sealing license for this one original payment. A fixed-version license requires paid migration when the bank advice version changes; a flexible license follows that payment’s current version. This fee does not create or deliver a document.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "product_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "schedule_id", "product_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "single_payment_seals_and_bank_advice_versions", "service": "px_br_proof_versions", "portal": "psp", "applicable_entity": "Enrolled preliminary and final payment-proof delivery.", "interface_document": "PX-BR-PROOF-VERSIONS", "rule_documents": [ "PX-BR-PROOF-VERSIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "migrate_payment_proof_seal": { "definition": { "name": "migrate_payment_proof_seal", "description": "Migrate a fixed bank proof license to the currently published advice version. The service fee is spent now; the license becomes ready only on its migration completion event. Existing issued copies and past disclosure remain unchanged.", "parameters": { "type": "object", "properties": { "seal_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "channel": { "type": "string", "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "seal_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "single_payment_seals_and_bank_advice_versions", "service": "px_br_proof_versions", "portal": "psp", "applicable_entity": "Enrolled preliminary and final payment-proof delivery.", "interface_document": "PX-BR-PROOF-VERSIONS", "rule_documents": [ "PX-BR-PROOF-VERSIONS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "select_payment_proof_rendering": { "definition": { "name": "select_payment_proof_rendering", "description": "Select an owned ready sealing license and a published rendering for subsequent evidence creation. Rendering descriptions include supporting source fields and transaction attachments. Selecting or correcting a rendering does not itself disclose information.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "seal_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "rendering_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "schedule_id", "seal_id", "rendering_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "derived_payment_fields_and_source_attachments", "service": "px_br_proof_lineage", "portal": "psp", "applicable_entity": "Bank receipts rendered for a named recipient under customer consent.", "interface_document": "PX-BR-PROOF-LINEAGE", "rule_documents": [ "PX-BR-PROOF-LINEAGE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "book_equipment_commissioning": { "definition": { "name": "book_equipment_commissioning", "description": "Reserve a listed commissioning service before its booking deadline. The fee is nonrefundable; the reservation does not inspect the equipment or replace missing components.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Equipment performance schedule." }, "service": { "type": "string", "description": "Listed commissioning service key." } }, "required": [ "schedule_id", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "protected_procurement_performance", "service": "px_b_r67_performance", "portal": "psp", "applicable_entity": "Protected purchase orders with a commissioning calendar", "interface_document": "SUPPLEMENT-a71c92159204", "rule_documents": [ "SUPPLEMENT-a71c92159204" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "commission_received_equipment": { "definition": { "name": "commission_received_equipment", "description": "Start the booked installation only after the original paid equipment and any replacement kit have been accepted. Completion follows the service delay; accepting equipment is not commissioning it.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Equipment performance schedule." } }, "required": [ "schedule_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "protected_procurement_performance", "service": "px_b_r67_performance", "portal": "psp", "applicable_entity": "Protected purchase orders with a commissioning calendar", "interface_document": "SUPPLEMENT-a71c92159204", "rule_documents": [ "SUPPLEMENT-a71c92159204" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_store_dispatch_channel": { "definition": { "name": "reserve_store_dispatch_channel", "description": "Reserve one dispatch instruction on a published channel. Capacity counts dispatched lines, and the booking fee is retained even if the chosen stock later proves unsuitable.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Original storefront delivery schedule." }, "channel": { "type": "string", "description": "Channel key in dispatch services." } }, "required": [ "schedule_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "paid_order_fulfilment", "service": "px_b_r69_lines", "portal": "psp", "applicable_entity": "Store orders with separately scheduled delivery lines", "interface_document": "PX-B-R34-LINES", "rule_documents": [ "PX-B-R34-LINES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "dispatch_store_delivery_line": { "definition": { "name": "dispatch_store_delivery_line", "description": "Irrevocably dispatch specific physical units for one paid order line through a booked channel. Stock is consumed once. The warehouse accepts the selected units; contractual grade and destination deadline remain the merchant responsibility.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Storefront delivery schedule." }, "line_id": { "type": "string", "description": "Delivery line ID." }, "stock_ids": { "type": "array", "description": "Distinct original or substitute physical stock IDs.", "items": { "type": "string" } }, "booking_id": { "type": "string", "description": "Unused dispatch booking." } }, "required": [ "schedule_id", "line_id", "stock_ids", "booking_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "paid_order_fulfilment", "service": "px_b_r69_lines", "portal": "psp", "applicable_entity": "Store orders with separately scheduled delivery lines", "interface_document": "PX-B-R34-LINES", "rule_documents": [ "PX-B-R34-LINES" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "review_platform_return_liability": { "definition": { "name": "review_platform_return_liability", "description": "Request the final customer-return amount attached to accepted platform revenue. The published range is a forecast; the review event establishes the actual remaining obligation.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Platform revenue settlement calendar." } }, "required": [ "schedule_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_payment_discontinuation", "service": "px_b_r70_exit", "portal": "psp", "applicable_entity": "Platform receiving accounts with pending customer returns and manual receipts", "interface_document": "PX-B-R35-EXIT", "rule_documents": [ "PX-B-R35-EXIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_platform_refund_channel": { "definition": { "name": "reserve_platform_refund_channel", "description": "Reserve the pre-booked refund channel at its published nonrefundable fee. This reserves one execution, not the customer refund amount.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Platform revenue settlement calendar." }, "channel": { "type": "string", "description": "Refund channel key." } }, "required": [ "schedule_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_payment_discontinuation", "service": "px_b_r70_exit", "portal": "psp", "applicable_entity": "Platform receiving accounts with pending customer returns and manual receipts", "interface_document": "PX-B-R35-EXIT", "rule_documents": [ "PX-B-R35-EXIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_platform_customer_return": { "definition": { "name": "pay_platform_customer_return", "description": "Pay the reviewed customer refund from actual available company cash. The selected channel creates actual recipient receipt after its stated delay.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Platform settlement schedule." }, "channel": { "type": "string", "description": "Refund channel key." }, "amount_minor": { "type": "integer", "description": "Positive customer refund principal in minor units." } }, "required": [ "schedule_id", "channel", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_payment_discontinuation", "service": "px_b_r70_exit", "portal": "psp", "applicable_entity": "Platform receiving accounts with pending customer returns and manual receipts", "interface_document": "PX-B-R35-EXIT", "rule_documents": [ "PX-B-R35-EXIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "sweep_platform_receipts": { "definition": { "name": "sweep_platform_receipts", "description": "Transfer positive available platform proceeds to the company treasury using a listed service. Early transfers are irrevocable; the bank does not reserve cash for unpaid customer-return obligations.", "parameters": { "type": "object", "properties": { "schedule_id": { "type": "string", "description": "Platform settlement schedule." }, "service": { "type": "string", "description": "Treasury sweep service key." }, "amount_minor": { "type": "integer", "description": "Positive treasury principal in minor units." } }, "required": [ "schedule_id", "service", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "platform_payment_discontinuation", "service": "px_b_r70_exit", "portal": "psp", "applicable_entity": "Platform receiving accounts with pending customer returns and manual receipts", "interface_document": "PX-B-R35-EXIT", "rule_documents": [ "PX-B-R35-EXIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "retrieve_statement_segment": { "definition": { "name": "retrieve_statement_segment", "description": "Obtain bank statement rows. missing_range retrieves only the missing detailed range for the quoted fee; full_replacement retrieves every original row; summary returns only opening/closing balances. A discarded archive cannot be recovered.", "parameters": { "type": "object", "properties": { "statement_id": { "type": "string", "description": "statement id" }, "product": { "type": "string", "enum": [ "missing_range", "full_replacement", "summary" ], "description": "product" } }, "required": [ "statement_id", "product" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "bank_statement_completeness_and_day_end", "service": "px_c_92", "portal": "psp", "applicable_entity": "Synthetic Bank statement completeness and day-end product only; monetary amounts are integer minor units.", "interface_document": "PX-C-46", "rule_documents": [ "PX-C-46" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "assign_statement_entry": { "definition": { "name": "assign_statement_entry", "description": "Assign an imported entry to a business category. Assignment records accounting attribution, not a change to the bank amount; categories must follow the customer's business facts.", "parameters": { "type": "object", "properties": { "entry_id": { "type": "string", "description": "entry id" }, "category": { "type": "string", "enum": [ "sales", "supplier_payment", "supplier_refund", "bank_fee", "internal_transfer", "unallocated" ], "description": "category" } }, "required": [ "entry_id", "category" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "bank_statement_completeness_and_day_end", "service": "px_c_92", "portal": "psp", "applicable_entity": "Synthetic Bank statement completeness and day-end product only; monetary amounts are integer minor units.", "interface_document": "PX-C-46", "rule_documents": [ "PX-C-46" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "finalize_statement_day": { "definition": { "name": "finalize_statement_day", "description": "Publish a day-end report. complete requires every bank sequence and a category; balance_only is an available legacy report that certifies only endpoint arithmetic. discard_archive irreversibly removes the original source and does not close the day.", "parameters": { "type": "object", "properties": { "statement_id": { "type": "string", "description": "statement id" }, "method": { "type": "string", "enum": [ "complete", "balance_only", "discard_archive" ], "description": "method" } }, "required": [ "statement_id", "method" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "bank_statement_completeness_and_day_end", "service": "px_c_92", "portal": "psp", "applicable_entity": "Synthetic Bank statement completeness and day-end product only; monetary amounts are integer minor units.", "interface_document": "PX-C-46", "rule_documents": [ "PX-C-46" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "recover_payment_posting": { "definition": { "name": "recover_payment_posting", "description": "Repair accounting for a successful bank execution. replay_all/replay_cash/replay_payable/replay_order are idempotent and derive records from its receipt. manual_status marks an order without journal repair. write_off removes the payable through a separate expense entry. replay_reversal derives reversal_payable_credit and reversal_cash_debit from a published bank-return receipt and projects RETURNED. discard_receipt removes the local recovery copy. No mode executes a bank transfer.", "parameters": { "type": "object", "properties": { "execution_id": { "type": "string", "description": "execution id" }, "mode": { "type": "string", "enum": [ "replay_all", "replay_cash", "replay_payable", "replay_order", "replay_reversal", "manual_status", "write_off", "discard_receipt" ], "description": "mode" } }, "required": [ "execution_id", "mode" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "settled_payment_accounting_recovery", "service": "px_c_93", "portal": "psp", "applicable_entity": "Synthetic Settled payment accounting recovery product only; monetary amounts are integer minor units.", "interface_document": "PX-C-47", "rule_documents": [ "PX-C-47" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "resolve_settled_transfer": { "definition": { "name": "resolve_settled_transfer", "description": "Request an actual bank action on a settled execution: resend creates an additional irrevocable transfer, while compensate returns the original amount and cancels its supplier obligation. These are financial actions, not accounting recovery.", "parameters": { "type": "object", "properties": { "execution_id": { "type": "string", "description": "execution id" }, "action": { "type": "string", "enum": [ "resend", "compensate" ], "description": "action" } }, "required": [ "execution_id", "action" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "settled_payment_accounting_recovery", "service": "px_c_93", "portal": "psp", "applicable_entity": "Synthetic Settled payment accounting recovery product only; monetary amounts are integer minor units.", "interface_document": "PX-C-47", "rule_documents": [ "PX-C-47" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "review_screening_hit": { "definition": { "name": "review_screening_hit", "description": "Review a name hit under the local frozen policy. standard or express requires a registry_extract upload and publishes an identity match using registry number plus control identifier. Express charges the posted fee. withdraw irreversibly cancels the associated invoice; names alone cannot clear an actual identity match.", "parameters": { "type": "object", "properties": { "hit_id": { "type": "string", "description": "hit id" }, "service": { "type": "string", "enum": [ "standard", "express", "withdraw" ], "description": "service" } }, "required": [ "hit_id", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "frozen_entity_screening", "service": "px_c_84", "portal": "psp", "applicable_entity": "Synthetic Frozen entity screening product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-2e4e12273ff0", "rule_documents": [ "SUPPLEMENT-2e4e12273ff0" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_screened_invoice": { "definition": { "name": "pay_screened_invoice", "description": "Pay a screened invoice only after its own identity hit is cleared. Each invoice is independent; another party's clearance cannot be reused.", "parameters": { "type": "object", "properties": { "hit_id": { "type": "string", "description": "hit id" } }, "required": [ "hit_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "frozen_entity_screening", "service": "px_c_84", "portal": "psp", "applicable_entity": "Synthetic Frozen entity screening product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-2e4e12273ff0", "rule_documents": [ "SUPPLEMENT-2e4e12273ff0" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "verify_supplier_change": { "definition": { "name": "verify_supplier_change", "description": "Contact the supplier through the selected public directory channel. Contract callback and secure portal are independent channels; email_reply only records the email sender's assertion. Fees and resulting authority are recorded. The bank never infers supplier authority from account existence.", "parameters": { "type": "object", "properties": { "change_id": { "type": "string", "description": "change id" }, "channel": { "type": "string", "enum": [ "contract_callback", "secure_portal", "email_reply", "rush_callback" ], "description": "channel" } }, "required": [ "change_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_supplier_change_authentication", "service": "px_c_85", "portal": "psp", "applicable_entity": "Synthetic Independent supplier change authentication product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-312394df1e63", "rule_documents": [ "SUPPLEMENT-312394df1e63" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_supplier_account": { "definition": { "name": "pay_supplier_account", "description": "Send an irrevocable invoice payment to one of the bank-valid accounts listed on its change record. Bank validity does not establish that a supplier authorized the change. standard and instant have the posted transfer fees.", "parameters": { "type": "object", "properties": { "change_id": { "type": "string", "description": "change id" }, "account_reference": { "type": "string", "description": "account reference" }, "speed": { "type": "string", "enum": [ "standard", "instant" ], "description": "speed" } }, "required": [ "change_id", "account_reference", "speed" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_supplier_change_authentication", "service": "px_c_85", "portal": "psp", "applicable_entity": "Synthetic Independent supplier change authentication product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-312394df1e63", "rule_documents": [ "SUPPLEMENT-312394df1e63" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "configure_card_policy": { "definition": { "name": "configure_card_policy", "description": "Configure the synthetic corporate card. merchant_exception sets one merchant's per-transaction cap; category_limit sets one category cap; global_limit sets the cycle cap; block_category adds a deny; allow_category removes a deny; freeze disables spending. Denies override exceptions; transaction caps and remaining cycle cap both apply.", "parameters": { "type": "object", "properties": { "card_id": { "type": "string", "description": "card id" }, "mode": { "type": "string", "enum": [ "merchant_exception", "category_limit", "global_limit", "block_category", "allow_category", "freeze" ], "description": "mode" }, "selector": { "type": "string", "description": "selector" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "card_id", "mode", "selector", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_corporate_card_policy", "service": "px_c_86", "portal": "psp", "applicable_entity": "Synthetic Synthetic corporate card policy product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-878444935a1d", "rule_documents": [ "SUPPLEMENT-878444935a1d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "execute_card_purchase": { "definition": { "name": "execute_card_purchase", "description": "Attempt one synthetic corporate-card purchase. It debits cash and occupies cycle capacity only when the active card, category deny, transaction cap and cycle cap all permit it.", "parameters": { "type": "object", "properties": { "purchase_id": { "type": "string", "description": "purchase id" } }, "required": [ "purchase_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_corporate_card_policy", "service": "px_c_86", "portal": "psp", "applicable_entity": "Synthetic Synthetic corporate card policy product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-878444935a1d", "rule_documents": [ "SUPPLEMENT-878444935a1d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "replace_network_card": { "definition": { "name": "replace_network_card", "description": "Replace a card in the synthetic token network. Replacing the PAN increments its generation; supported tokens update, unsupported tokens become STALE. Merchant agreements are unaffected. Closing the card disables all future charging.", "parameters": { "type": "object", "properties": { "network_card_id": { "type": "string", "description": "network card id" }, "action": { "type": "string", "enum": [ "replace", "close" ], "description": "action" } }, "required": [ "network_card_id", "action" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_token_lifecycle_and_recurring_agreements", "service": "px_c_87", "portal": "psp", "applicable_entity": "Synthetic Synthetic token lifecycle and recurring agreements product only; monetary amounts are integer minor units.", "interface_document": "PX-C-43", "rule_documents": [ "PX-C-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_merchant_token": { "definition": { "name": "manage_merchant_token", "description": "refresh provisions a token on the current card; revoke_token revokes a token but leaves its merchant agreement active; cancel_agreement terminates its recurring contract and revokes the token. An active agreement may reprovision a revoked token on the next billing cycle.", "parameters": { "type": "object", "properties": { "token_id": { "type": "string", "description": "token id" }, "action": { "type": "string", "enum": [ "refresh", "revoke_token", "cancel_agreement" ], "description": "action" } }, "required": [ "token_id", "action" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_token_lifecycle_and_recurring_agreements", "service": "px_c_87", "portal": "psp", "applicable_entity": "Synthetic Synthetic token lifecycle and recurring agreements product only; monetary amounts are integer minor units.", "interface_document": "PX-C-43", "rule_documents": [ "PX-C-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "run_merchant_billing": { "definition": { "name": "run_merchant_billing", "description": "Process the next due recurring cycle once. Active agreements with revoked tokens may reprovision under their existing agreement; stale tokens fail. Cancelled agreements are skipped. Each merchant has one due invoice.", "parameters": { "type": "object", "properties": { "network_card_id": { "type": "string", "description": "network card id" } }, "required": [ "network_card_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_token_lifecycle_and_recurring_agreements", "service": "px_c_87", "portal": "psp", "applicable_entity": "Synthetic Synthetic token lifecycle and recurring agreements product only; monetary amounts are integer minor units.", "interface_document": "PX-C-43", "rule_documents": [ "PX-C-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "obtain_terminal_audit": { "definition": { "name": "obtain_terminal_audit", "description": "Retrieve the frozen terminal consent log for one synthetic DCC transaction. The audit publishes the cardholder's actual currency choice. No adjustment is made by this retrieval.", "parameters": { "type": "object", "properties": { "transaction_id": { "type": "string", "description": "transaction id" } }, "required": [ "transaction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_dcc_consent_and_adjustments", "service": "px_c_88", "portal": "psp", "applicable_entity": "Synthetic Synthetic DCC consent and adjustments product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-bb6f914ba77c", "rule_documents": [ "SUPPLEMENT-bb6f914ba77c" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "resolve_currency_dispute": { "definition": { "name": "resolve_currency_dispute", "description": "Resolve synthetic dynamic-currency-conversion charges. formal_adjustment requires a terminal audit showing local-currency choice and credits billed minus local principal converted at the disclosed network rate; legitimate fixed fees remain. goodwill credits the disclosed offer and waives further recovery; waive closes with no credit. Premium service charges its non-refundable fee.", "parameters": { "type": "object", "properties": { "transaction_id": { "type": "string", "description": "transaction id" }, "resolution": { "type": "string", "enum": [ "formal_adjustment", "goodwill", "waive" ], "description": "resolution" }, "service": { "type": "string", "enum": [ "standard", "premium" ], "description": "service" } }, "required": [ "transaction_id", "resolution", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_dcc_consent_and_adjustments", "service": "px_c_88", "portal": "psp", "applicable_entity": "Synthetic Synthetic DCC consent and adjustments product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-bb6f914ba77c", "rule_documents": [ "SUPPLEMENT-bb6f914ba77c" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "obtain_cash_delivery_log": { "definition": { "name": "obtain_cash_delivery_log", "description": "Retrieve physical delivery records for the dedicated synthetic cash network. device_log or acquirer_copy publishes presented and retracted cash; actual delivery is presented minus retracted. express is an expensive equivalent evidence service.", "parameters": { "type": "object", "properties": { "cash_transaction_id": { "type": "string", "description": "cash transaction id" }, "source": { "type": "string", "enum": [ "device_log", "acquirer_copy", "express" ], "description": "source" } }, "required": [ "cash_transaction_id", "source" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery_atm_presentation_retraction_vault_cash_custody", "service": "px_c_89", "portal": "psp", "applicable_entity": "Dedicated synthetic cash network", "interface_document": "SUPPLEMENT-1ea5d55f66f9", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_cash_shortfall": { "definition": { "name": "settle_cash_shortfall", "description": "Close a synthetic withdrawal claim. exact credits evidenced shortage minus physical cash already handed over. full_and_final credits the public offer capped at that remaining right and waives the rest; waive credits zero. Physical recovery must precede this final disposition.", "parameters": { "type": "object", "properties": { "cash_transaction_id": { "type": "string", "description": "cash transaction id" }, "choice": { "type": "string", "enum": [ "exact", "full_and_final", "waive" ], "description": "choice" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "cash_transaction_id", "choice", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery_atm_presentation_retraction_vault_cash_custody", "service": "px_c_89", "portal": "psp", "applicable_entity": "Dedicated synthetic cash network", "interface_document": "SUPPLEMENT-1ea5d55f66f9", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reconcile_carrier_cash": { "definition": { "name": "reconcile_carrier_cash", "description": "Publish the carrier inventory for a COD batch and establish actual cash held per delivered order. standard and express have posted non-refundable inventory fees. Returned parcels create no COD debt.", "parameters": { "type": "object", "properties": { "batch_id": { "type": "string", "description": "batch id" }, "service": { "type": "string", "enum": [ "standard", "express" ], "description": "service" } }, "required": [ "batch_id", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_cod_cash_custody", "service": "px_c_90", "portal": "psp", "applicable_entity": "Synthetic Carrier COD cash custody product only; monetary amounts are integer minor units.", "interface_document": "PX-C-44", "rule_documents": [ "PX-C-44" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_carrier_collection": { "definition": { "name": "settle_carrier_collection", "description": "remit_cash pays actual inventoried cash less order-specific commission exactly once; carrier_shortfall assigns the missing entrusted cash to the carrier and collects it; merchant_shortfall accepts the shortage as the merchant's loss; waive_collection forgives the batch. The last three choices are final liability dispositions.", "parameters": { "type": "object", "properties": { "batch_id": { "type": "string", "description": "batch id" }, "action": { "type": "string", "enum": [ "remit_cash", "carrier_shortfall", "merchant_shortfall", "waive_collection" ], "description": "action" } }, "required": [ "batch_id", "action" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_cod_cash_custody", "service": "px_c_90", "portal": "psp", "applicable_entity": "Synthetic Carrier COD cash custody product only; monetary amounts are integer minor units.", "interface_document": "PX-C-44", "rule_documents": [ "PX-C-44" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "synchronize_sales_tax_events": { "definition": { "name": "synchronize_sales_tax_events", "description": "Import the order platform's authoritative delivery-location and return events. Tax responsibility and refundable tax update per order; previously submitted tax is not silently rewritten.", "parameters": { "type": "object", "properties": { "tax_batch_id": { "type": "string", "description": "tax batch id" } }, "required": [ "tax_batch_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_marketplace_sales_tax", "service": "px_c_91", "portal": "psp", "applicable_entity": "Synthetic Synthetic marketplace sales tax product only; monetary amounts are integer minor units.", "interface_document": "PX-C-45", "rule_documents": [ "PX-C-45" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "remit_order_sales_tax": { "definition": { "name": "remit_order_sales_tax", "description": "Remit the currently displayed tax less refunded tax for the selected orders. Bank execution permits payment even when the platform is the responsible collector, or when a previous remittance exists; those choices may create duplicate tax. All selected orders must belong to the same batch.", "parameters": { "type": "object", "properties": { "tax_batch_id": { "type": "string", "description": "tax batch id" }, "order_ids": { "type": "array", "description": "order ids" } }, "required": [ "tax_batch_id", "order_ids" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_marketplace_sales_tax", "service": "px_c_91", "portal": "psp", "applicable_entity": "Synthetic Synthetic marketplace sales tax product only; monetary amounts are integer minor units.", "interface_document": "PX-C-45", "rule_documents": [ "PX-C-45" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "publish_sales_tax_close": { "definition": { "name": "publish_sales_tax_close", "description": "Publish the merchant's sales-tax close using current order amounts and actual remittances. It records net merchant revenue and does not itself remit, refund or alter tax responsibility.", "parameters": { "type": "object", "properties": { "tax_batch_id": { "type": "string", "description": "tax batch id" } }, "required": [ "tax_batch_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_marketplace_sales_tax", "service": "px_c_91", "portal": "psp", "applicable_entity": "Synthetic Synthetic marketplace sales tax product only; monetary amounts are integer minor units.", "interface_document": "PX-C-45", "rule_documents": [ "PX-C-45" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "fund_safeguard_pool": { "definition": { "name": "fund_safeguard_pool", "description": "Transfer institutional cash into the synthetic safeguard pool, or elect to charge a customer a fee. own_cash debits the institution's operating account; customer_fee reduces the named customer's liability as a collected fee. accrued_fee merely recognizes an unpaid receivable and creates no protected cash. other_customer moves another customer's reserved cash and records the ownership breach.", "parameters": { "type": "object", "properties": { "pool_id": { "type": "string", "description": "pool id" }, "source": { "type": "string", "enum": [ "own_cash", "customer_fee", "accrued_fee", "other_customer" ], "description": "source" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "pool_id", "source", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_customer_money_safeguarding", "service": "px_c_95", "portal": "psp", "applicable_entity": "Synthetic Synthetic customer money safeguarding product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-b3f22e7841bc", "rule_documents": [ "SUPPLEMENT-b3f22e7841bc" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_protected_customer": { "definition": { "name": "settle_protected_customer", "description": "Pay the target customer's instructed amount from the pooled bank account and reduce that customer's liability. Bank execution checks cash, while safeguarding coverage must independently be maintained. Surplus institutional cash can be released with release_surplus only if all remaining liabilities remain covered.", "parameters": { "type": "object", "properties": { "pool_id": { "type": "string", "description": "pool id" }, "action": { "type": "string", "enum": [ "settle_customer", "release_surplus" ], "description": "action" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "pool_id", "action", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_customer_money_safeguarding", "service": "px_c_95", "portal": "psp", "applicable_entity": "Synthetic Synthetic customer money safeguarding product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-b3f22e7841bc", "rule_documents": [ "SUPPLEMENT-b3f22e7841bc" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "cancel_channel_queue_item": { "definition": { "name": "cancel_channel_queue_item", "description": "Cancel an original channel item only while it is QUEUED. A confirmed cancellation is recorded immediately. Already accepted/settled items cannot be recalled with queue cancellation.", "parameters": { "type": "object", "properties": { "item_id": { "type": "string", "description": "item id" } }, "required": [ "item_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "selective_payment_channel_recovery", "service": "px_c_96", "portal": "psp", "applicable_entity": "Synthetic Selective payment channel recovery product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-11bc5d293cb7", "rule_documents": [ "SUPPLEMENT-11bc5d293cb7" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "send_channel_replacement": { "definition": { "name": "send_channel_replacement", "description": "Create a new economic transfer through standard_fallback or express_fallback for one item. The bank permits a new transfer even if an original is accepted or queued; that original continues and can cause a duplicate. abandon cancels the business obligation without paying it.", "parameters": { "type": "object", "properties": { "item_id": { "type": "string", "description": "item id" }, "route": { "type": "string", "enum": [ "standard_fallback", "express_fallback", "abandon" ], "description": "route" } }, "required": [ "item_id", "route" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "selective_payment_channel_recovery", "service": "px_c_96", "portal": "psp", "applicable_entity": "Synthetic Selective payment channel recovery product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-11bc5d293cb7", "rule_documents": [ "SUPPLEMENT-11bc5d293cb7" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "refresh_channel_settlements": { "definition": { "name": "refresh_channel_settlements", "description": "Import actual original-channel settlement notifications and the public recovery event. Accepted items settle; queued items settle after channel recovery unless explicitly cancelled. A replacement never cancels the original.", "parameters": { "type": "object", "properties": { "batch_id": { "type": "string", "description": "batch id" } }, "required": [ "batch_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "fallback_capacity_and_original_channel_settlement_windows", "service": "px_c_r96", "portal": "psp", "applicable_entity": "Synthetic linked contracts for the current customer with reasoning_version c-reasoning-v2.", "interface_document": "SUPPLEMENT-13f05c805b95", "rule_documents": [ "SUPPLEMENT-13f05c805b95" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "release_queue_reservation": { "definition": { "name": "release_queue_reservation", "description": "Release one reservation. Its owner's publicly quoted cancellation fee is charged; the payment obligation remains open. All reservations are exclusive cash holds even when their currency belongs to an obsolete payment plan.", "parameters": { "type": "object", "properties": { "reservation_id": { "type": "string", "description": "reservation id" } }, "required": [ "reservation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "currency_reservation_wait_cycles", "service": "px_c_97", "portal": "psp", "applicable_entity": "Synthetic Currency reservation wait cycles product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-16c3248a3271", "rule_documents": [ "SUPPLEMENT-16c3248a3271" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "swap_queue_reservations": { "definition": { "name": "swap_queue_reservations", "description": "Atomically release obsolete currency holds and reserve each owner's actual payable currency. This coordination service charges the public swap fee once and requires the combined cash balances to cover all unpaid obligations.", "parameters": { "type": "object", "properties": { "queue_id": { "type": "string", "description": "queue id" } }, "required": [ "queue_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "currency_reservation_wait_cycles", "service": "px_c_97", "portal": "psp", "applicable_entity": "Synthetic Currency reservation wait cycles product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-16c3248a3271", "rule_documents": [ "SUPPLEMENT-16c3248a3271" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "execute_reserved_payment": { "definition": { "name": "execute_reserved_payment", "description": "Execute a resource-queue payment using available cash plus its own correctly denominated hold. Other owners' holds are unavailable. Completion releases all of this owner's remaining obsolete holds. expedite adds the disclosed optional processing fee.", "parameters": { "type": "object", "properties": { "payment_id": { "type": "string", "description": "payment id" }, "service": { "type": "string", "enum": [ "standard", "expedite" ], "description": "service" } }, "required": [ "payment_id", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "currency_reservation_wait_cycles", "service": "px_c_97", "portal": "psp", "applicable_entity": "Synthetic Currency reservation wait cycles product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-16c3248a3271", "rule_documents": [ "SUPPLEMENT-16c3248a3271" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "adopt_payment_plan": { "definition": { "name": "adopt_payment_plan", "description": "Adopt one publicly offered restructuring plan after user approval of this exact request. The plan's fee is charged, and its concrete flexible principal and due minute replace that obligation's terms. Reduction is a legal supplier concession but may violate the customer's preference to pay in full.", "parameters": { "type": "object", "properties": { "plan_id": { "type": "string", "description": "plan id" } }, "required": [ "plan_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "negotiated_infeasible_payment_plans", "service": "px_c_98", "portal": "psp", "applicable_entity": "Synthetic Negotiated infeasible payment plans product only; monetary amounts are integer minor units.", "interface_document": "PX-C-48", "rule_documents": [ "PX-C-48" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "collect_committed_receivable": { "definition": { "name": "collect_committed_receivable", "description": "Collect the verified customer receivable once its public available minute is reached. Early collection is unavailable and it cannot be borrowed against without a separate product.", "parameters": { "type": "object", "properties": { "negotiation_id": { "type": "string", "description": "negotiation id" } }, "required": [ "negotiation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "negotiated_infeasible_payment_plans", "service": "px_c_98", "portal": "psp", "applicable_entity": "Synthetic Negotiated infeasible payment plans product only; monetary amounts are integer minor units.", "interface_document": "PX-C-48", "rule_documents": [ "PX-C-48" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_negotiated_obligation": { "definition": { "name": "pay_negotiated_obligation", "description": "Pay the obligation's currently contracted amount. Cash is checked, and the actual execution minute is recorded so lateness remains visible even when a bank accepts the transfer.", "parameters": { "type": "object", "properties": { "obligation_id": { "type": "string", "description": "obligation id" } }, "required": [ "obligation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "negotiated_infeasible_payment_plans", "service": "px_c_98", "portal": "psp", "applicable_entity": "Synthetic Negotiated infeasible payment plans product only; monetary amounts are integer minor units.", "interface_document": "PX-C-48", "rule_documents": [ "PX-C-48" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "purchase_route_inquiry": { "definition": { "name": "purchase_route_inquiry", "description": "Buy a formal route eligibility inquiry. standard and rush reveal the same pre-existing bank outcome at different posted fees; no user selects the outcome. Duplicate purchases are allowed and charged. The response is recorded as a formal receipt.", "parameters": { "type": "object", "properties": { "offer_id": { "type": "string", "description": "offer id" }, "service": { "type": "string", "enum": [ "standard", "rush" ], "description": "service" } }, "required": [ "offer_id", "service" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "priced_route_inquiry_and_informed_commitment", "service": "px_c_99", "portal": "psp", "applicable_entity": "Synthetic Priced route inquiry and informed commitment product only; monetary amounts are integer minor units.", "interface_document": "PX-C-49", "rule_documents": [ "PX-C-49" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "commit_payment_route": { "definition": { "name": "commit_payment_route", "description": "Commit and pay the complete obligation. economical requires a favorable formal inquiry; conservative is available without inquiry; premium is an expensive guaranteed route. Each is an irrevocable transfer, so the offer can be committed only once. All fees are public on the offer.", "parameters": { "type": "object", "properties": { "offer_id": { "type": "string", "description": "offer id" }, "route": { "type": "string", "enum": [ "economical", "conservative", "premium" ], "description": "route" } }, "required": [ "offer_id", "route" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "priced_route_inquiry_and_informed_commitment", "service": "px_c_99", "portal": "psp", "applicable_entity": "Synthetic Priced route inquiry and informed commitment product only; monetary amounts are integer minor units.", "interface_document": "PX-C-49", "rule_documents": [ "PX-C-49" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "configure_wallet_automation": { "definition": { "name": "configure_wallet_automation", "description": "Configure the synthetic wallet controller. topup triggers below threshold_minor and transfers amount_minor, with its fee deducted from the credited amount; sweep triggers above threshold_minor and transfers excess down to amount_minor (its target). enabled and cooldown_cycles are explicit. Both rules are required for the customer's normal operation.", "parameters": { "type": "object", "properties": { "controller_id": { "type": "string", "description": "controller id" }, "rule": { "type": "string", "enum": [ "topup", "sweep" ], "description": "rule" }, "threshold_minor": { "type": "integer", "description": "threshold minor (integer minor currency units)" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" }, "enabled": { "type": "boolean", "description": "enabled" }, "cooldown_cycles": { "type": "integer", "description": "cooldown cycles" } }, "required": [ "controller_id", "rule", "threshold_minor", "amount_minor", "enabled", "cooldown_cycles" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "wallet_feedback_control_and_observation", "service": "px_c_100", "portal": "psp", "applicable_entity": "Synthetic Wallet feedback control and observation product only; monetary amounts are integer minor units.", "interface_document": "PX-C-50", "rule_documents": [ "PX-C-50" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "run_wallet_observation": { "definition": { "name": "run_wallet_observation", "description": "Run a finite number of real automation cycles, 1--12. Each cycle applies topup, then sweep, then retries the single due business purchase. Every cash movement and fee is posted; the purchase is never paid twice. A cooldown suppresses only its own rule, and successive calls continue the same clock.", "parameters": { "type": "object", "properties": { "controller_id": { "type": "string", "description": "controller id" }, "cycles": { "type": "integer", "description": "cycles" } }, "required": [ "controller_id", "cycles" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "wallet_feedback_control_and_observation", "service": "px_c_100", "portal": "psp", "applicable_entity": "Synthetic Wallet feedback control and observation product only; monetary amounts are integer minor units.", "interface_document": "PX-C-50", "rule_documents": [ "PX-C-50" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_delivery_acceptance": { "definition": { "name": "manage_delivery_acceptance", "description": "Inspect contracted quantities; a supplier replacement cures a confirmed short delivery. Acceptance binds the original screened supplier and collection account. Warranty release or retention is a separate enforceable supplier promise. Actions: inspect_goods, request_replacement, record_goods_acceptance, select_collection_account, set_warranty_amount. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "inspect_goods", "request_replacement", "record_goods_acceptance", "select_collection_account", "set_warranty_amount" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "frozen_entity_screening", "service": "px_c_84", "portal": "psp", "applicable_entity": "Synthetic Frozen entity screening product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-2e4e12273ff0", "rule_documents": [ "SUPPLEMENT-2e4e12273ff0" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_supplier_credit_note": { "definition": { "name": "manage_supplier_credit_note", "description": "Import the supplier credit statement, apply or expressly forgive its credit, authenticate collection-account ownership and bind a remittance reference. Reconciliation preserves the supplier balance and the credit claim. Actions: retrieve_credit_statement, apply_credit_note, select_collection_account, bind_remittance_reference, reconcile_supplier_statement. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_credit_statement", "apply_credit_note", "select_collection_account", "bind_remittance_reference", "reconcile_supplier_statement" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "independent_supplier_change_authentication", "service": "px_c_85", "portal": "psp", "applicable_entity": "Synthetic Independent supplier change authentication product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-312394df1e63", "rule_documents": [ "SUPPLEMENT-312394df1e63" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_card_authorization": { "definition": { "name": "manage_card_authorization", "description": "Obtain bank status for authorization holds. A void order can be cancelled; cancelling a delivered order waives its reservation without cancelling its debt. Employee scope and a required-purchase reservation jointly consume available cycle permission. Actions: retrieve_authorizations, cancel_authorization, assign_employee, reserve_purchase_amount. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_authorizations", "cancel_authorization", "assign_employee", "reserve_purchase_amount" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_corporate_card_policy", "service": "px_c_86", "portal": "psp", "applicable_entity": "Synthetic Synthetic corporate card policy product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-878444935a1d", "rule_documents": [ "SUPPLEMENT-878444935a1d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_subscription_consent": { "definition": { "name": "manage_subscription_consent", "description": "Retrieve pending merchant captures independently of token replacement. Void the unwanted capture, renew named service consents and bind each consent to the current card generation. Cancellation of a token alone does not clear a pending capture. Actions: retrieve_capture_orders, dispose_capture, record_service_consent, bind_card_generation. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_capture_orders", "dispose_capture", "record_service_consent", "bind_card_generation" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_token_lifecycle_and_recurring_agreements", "service": "px_c_87", "portal": "psp", "applicable_entity": "Synthetic Synthetic token lifecycle and recurring agreements product only; monetary amounts are integer minor units.", "interface_document": "PX-C-43", "rule_documents": [ "PX-C-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_merchant_refund_case": { "definition": { "name": "manage_merchant_refund_case", "description": "Retrieve merchant refunds and classify their economic component. Evidence of the remaining conversion claim must deduct only matching conversion refunds. A final overlap reconciliation closes the refund liability; ignoring a refund or forgiving the remainder changes customer recovery. Actions: retrieve_refund_statement, allocate_merchant_refund, submit_conversion_evidence, reconcile_refund_settlement. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_refund_statement", "allocate_merchant_refund", "submit_conversion_evidence", "reconcile_refund_settlement" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_dcc_consent_and_adjustments", "service": "px_c_88", "portal": "psp", "applicable_entity": "Synthetic Synthetic DCC consent and adjustments product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-bb6f914ba77c", "rule_documents": [ "SUPPLEMENT-bb6f914ba77c" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_carrier_fee_claim": { "definition": { "name": "manage_carrier_fee_claim", "description": "Import parcel-level fee demands, dispute the fee on an unpaid returned parcel, and set off only contracted delivered-parcel commissions. Allocate actual recovered proceeds to buyer invoices; an advance allocation leaves them outstanding. Actions: retrieve_carrier_fees, settle_return_fee, offset_commission, allocate_remittance. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_carrier_fees", "settle_return_fee", "offset_commission", "allocate_remittance" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_cod_cash_custody", "service": "px_c_90", "portal": "psp", "applicable_entity": "Synthetic Carrier COD cash custody product only; monetary amounts are integer minor units.", "interface_document": "PX-C-44", "rule_documents": [ "PX-C-44" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_tax_registration": { "definition": { "name": "manage_tax_registration", "description": "Obtain current destination tax-registration status, register the correct destination, and assign an existing credit only within its jurisdiction. The close must expose the utilized and retained tax-credit schedule. Actions: retrieve_jurisdiction_status, register_jurisdiction, reserve_tax_credit, publish_credit_schedule. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_jurisdiction_status", "register_jurisdiction", "reserve_tax_credit", "publish_credit_schedule" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_marketplace_sales_tax", "service": "px_c_91", "portal": "psp", "applicable_entity": "Synthetic Synthetic marketplace sales tax product only; monetary amounts are integer minor units.", "interface_document": "PX-C-45", "rule_documents": [ "PX-C-45" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_interaccount_match": { "definition": { "name": "manage_interaccount_match", "description": "Obtain the bank transfer reference and pair the debit/credit legs across accounts. Elimination affects consolidated reporting, not either source statement. Publish the consolidated close only after the two complete source days exist. Actions: retrieve_transfer_advice, match_bank_reference, post_consolidation_entry, publish_consolidated_report. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_transfer_advice", "match_bank_reference", "post_consolidation_entry", "publish_consolidated_report" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "bank_statement_completeness_and_day_end", "service": "px_c_92", "portal": "psp", "applicable_entity": "Synthetic Bank statement completeness and day-end product only; monetary amounts are integer minor units.", "interface_document": "PX-C-46", "rule_documents": [ "PX-C-46" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_recovery_period_binding": { "definition": { "name": "manage_recovery_period_binding", "description": "Obtain accounting-period locks; select a current open posting period while preserving the historical lock. A bank-return notice revives the supplier payable. Publish a rollforward from receipt-derived original and reversal components. Actions: retrieve_period_locks, select_posting_period, record_returned_payable, publish_rollforward. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_period_locks", "select_posting_period", "record_returned_payable", "publish_rollforward" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "settled_payment_accounting_recovery", "service": "px_c_93", "portal": "psp", "applicable_entity": "Synthetic Settled payment accounting recovery product only; monetary amounts are integer minor units.", "interface_document": "PX-C-47", "rule_documents": [ "PX-C-47" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_custody_bank_notice": { "definition": { "name": "manage_custody_bank_notice", "description": "Import a custody fee notice and allocate legal responsibility. Institution settlement pays its own expense; a receivable is not cash. Release only evidenced institution surplus after customer settlement, preserving remaining coverage. Actions: retrieve_custody_notice, allocate_fee_owner, settle_fee_allocation, certify_coverage. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_custody_notice", "allocate_fee_owner", "settle_fee_allocation", "certify_coverage" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "synthetic_customer_money_safeguarding", "service": "px_c_95", "portal": "psp", "applicable_entity": "Synthetic Synthetic customer money safeguarding product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-b3f22e7841bc", "rule_documents": [ "SUPPLEMENT-b3f22e7841bc" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_channel_business_key": { "definition": { "name": "manage_channel_business_key", "description": "Retrieve each original instruction and stable supplier business key. Bind recovery to those keys, quarantine cancelled originals, and acknowledge one receipt per obligation. Assigning new business keys permits a duplicate that the bank cannot infer is the same commercial debt. Actions: retrieve_instruction_register, bind_business_keys, set_cancelled_instruction_disposition, acknowledge_deliveries. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_instruction_register", "bind_business_keys", "set_cancelled_instruction_disposition", "acknowledge_deliveries" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "selective_payment_channel_recovery", "service": "px_c_96", "portal": "psp", "applicable_entity": "Synthetic Selective payment channel recovery product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-11bc5d293cb7", "rule_documents": [ "SUPPLEMENT-11bc5d293cb7" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_reservation_commitment": { "definition": { "name": "manage_reservation_commitment", "description": "Retrieve contracts behind reservations, preserve the still-live settlement promise, and bind each supplier currency acceptance. Release the obsolete commitment only after both protected currency payments have completed. Actions: retrieve_reservation_contracts, set_live_commitment, bind_supplier_currency, release_commitment. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_reservation_contracts", "set_live_commitment", "bind_supplier_currency", "release_commitment" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "currency_reservation_wait_cycles", "service": "px_c_97", "portal": "psp", "applicable_entity": "Synthetic Currency reservation wait cycles product only; monetary amounts are integer minor units.", "interface_document": "SUPPLEMENT-16c3248a3271", "rule_documents": [ "SUPPLEMENT-16c3248a3271" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_receivable_dispute": { "definition": { "name": "manage_receivable_dispute", "description": "Obtain a debtor confirmation separating an undisputed tranche from a disputed claim. Keep the disputed claim alive, collect only presently available money, and reconcile the eventual receipt to its tranche. Factoring the full face or forgiving the dispute changes the commercial claim. Actions: retrieve_debtor_confirmation, set_collection_tranche, set_disputed_claim_disposition, allocate_collection_receipt. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_debtor_confirmation", "set_collection_tranche", "set_disputed_claim_disposition", "allocate_collection_receipt" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "negotiated_infeasible_payment_plans", "service": "px_c_98", "portal": "psp", "applicable_entity": "Synthetic Negotiated infeasible payment plans product only; monetary amounts are integer minor units.", "interface_document": "PX-C-48", "rule_documents": [ "PX-C-48" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_beneficiary_delivery_terms": { "definition": { "name": "manage_beneficiary_delivery_terms", "description": "Validate beneficiary eligibility independently of route pricing, bind the authenticated account, obtain a quote for the selected delivery terms, and allocate correspondent charges. Sender-paid terms preserve the full principal; shared fees reduce the amount delivered. Actions: validate_beneficiary, select_beneficiary_account, obtain_delivery_quote, set_fee_bearer, reconcile_delivery. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "validate_beneficiary", "select_beneficiary_account", "obtain_delivery_quote", "set_fee_bearer", "reconcile_delivery" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "priced_route_inquiry_and_informed_commitment", "service": "px_c_99", "portal": "psp", "applicable_entity": "Synthetic Priced route inquiry and informed commitment product only; monetary amounts are integer minor units.", "interface_document": "PX-C-49", "rule_documents": [ "PX-C-49" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "manage_wallet_purchase_order": { "definition": { "name": "manage_wallet_purchase_order", "description": "Import merchant order cancellations, distinguish a duplicate from the required purchase, reserve the live merchant obligation and set its settlement priority. Reconcile the actual capture to the merchant order after the complete post-configuration observation window. Actions: retrieve_merchant_order_status, cancel_order, reserve_order_amount, set_clearing_priority, reconcile_capture. reference identifies the public business reference or named party; amount_minor records the explicit amount involved. Read the product article for local dependencies.", "parameters": { "type": "object", "properties": { "record_id": { "type": "string", "description": "record id" }, "action": { "type": "string", "enum": [ "retrieve_merchant_order_status", "cancel_order", "reserve_order_amount", "set_clearing_priority", "reconcile_capture" ], "description": "action" }, "reference": { "type": "string", "description": "reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "record_id", "action", "reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "wallet_feedback_control_and_observation", "service": "px_c_100", "portal": "psp", "applicable_entity": "Synthetic Wallet feedback control and observation product only; monetary amounts are integer minor units.", "interface_document": "PX-C-50", "rule_documents": [ "PX-C-50" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_wallet_closure_quote": { "definition": { "name": "request_wallet_closure_quote", "description": "Request the final closure charge assessment for wallet_id; the scheduled notice supplies the actual fee.", "parameters": { "type": "object", "properties": { "wallet_id": { "type": "string", "description": "wallet id" } }, "required": [ "wallet_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dust_balance_exit_minimum_outflow_currency_retirement", "service": "px_c_94", "portal": "psp", "applicable_entity": "Local synthetic wallet retirement", "interface_document": "SUPPLEMENT-a913d7fffad8", "rule_documents": [ "SUPPLEMENT-a913d7fffad8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_wallet_closure_charge": { "definition": { "name": "settle_wallet_closure_charge", "description": "Pay the assessed closure charge from its own wallet; fee_minor is read from the bank assessment.", "parameters": { "type": "object", "properties": { "wallet_id": { "type": "string", "description": "wallet id" } }, "required": [ "wallet_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dust_balance_exit_minimum_outflow_currency_retirement", "service": "px_c_94", "portal": "psp", "applicable_entity": "Local synthetic wallet retirement", "interface_document": "SUPPLEMENT-a913d7fffad8", "rule_documents": [ "SUPPLEMENT-a913d7fffad8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "consolidate_exit_cash": { "definition": { "name": "consolidate_exit_cash", "description": "Transfer positive amount_minor between same-currency customer wallets. This does not change their ownership or close either wallet.", "parameters": { "type": "object", "properties": { "source_wallet_id": { "type": "string", "description": "source wallet id" }, "destination_wallet_id": { "type": "string", "description": "destination wallet id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "source_wallet_id", "destination_wallet_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dust_balance_exit_minimum_outflow_currency_retirement", "service": "px_c_94", "portal": "psp", "applicable_entity": "Local synthetic wallet retirement", "interface_document": "SUPPLEMENT-a913d7fffad8", "rule_documents": [ "SUPPLEMENT-a913d7fffad8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_small_outflow_permission": { "definition": { "name": "request_small_outflow_permission", "description": "Request currency-scoped small-outflow review; the public non-refundable USD fee is paid from fee_wallet_id. Approval, cap and expiry arrive in a bank event.", "parameters": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "fee_wallet_id": { "type": "string", "description": "fee wallet id" } }, "required": [ "currency", "fee_wallet_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dust_balance_exit_minimum_outflow_currency_retirement", "service": "px_c_94", "portal": "psp", "applicable_entity": "Local synthetic wallet retirement", "interface_document": "SUPPLEMENT-a913d7fffad8", "rule_documents": [ "SUPPLEMENT-a913d7fffad8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "convert_exit_balance": { "definition": { "name": "convert_exit_balance", "description": "Convert source_amount_minor EUR from source_wallet_id into a USD destination_wallet_id at the public fixed rate, rounding down before deducting the public USD conversion fee.", "parameters": { "type": "object", "properties": { "source_wallet_id": { "type": "string", "description": "source wallet id" }, "destination_wallet_id": { "type": "string", "description": "destination wallet id" }, "source_amount_minor": { "type": "integer", "description": "source amount minor (integer minor currency units)" } }, "required": [ "source_wallet_id", "destination_wallet_id", "source_amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dust_balance_exit_minimum_outflow_currency_retirement", "service": "px_c_94", "portal": "psp", "applicable_entity": "Local synthetic wallet retirement", "interface_document": "SUPPLEMENT-a913d7fffad8", "rule_documents": [ "SUPPLEMENT-a913d7fffad8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_exit_outflow": { "definition": { "name": "submit_exit_outflow", "description": "Debit gross_amount_minor, subtract the selected tariff fee and deliver the net to external_account_id. The destination-currency net minimum or a current permission_id must be satisfied. Use an empty permission_id when relying on the normal minimum.", "parameters": { "type": "object", "properties": { "wallet_id": { "type": "string", "description": "wallet id" }, "external_account_id": { "type": "string", "description": "external account id" }, "gross_amount_minor": { "type": "integer", "description": "gross amount minor (integer minor currency units)" }, "tariff_id": { "type": "string", "description": "tariff id" }, "permission_id": { "type": "string", "description": "permission id" } }, "required": [ "wallet_id", "external_account_id", "gross_amount_minor", "tariff_id", "permission_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "wallet_exit", "service": "retirement", "portal": "psp", "applicable_entity": "retiring wallet", "interface_document": "IFACE-RETIRING-WALLET", "rule_documents": [ "SUPPLEMENT-a913d7fffad8", "SUPPLEMENT-ffd18286d235", "IFACE-RETIRING-WALLET" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "close_retiring_wallet": { "definition": { "name": "close_retiring_wallet", "description": "Close one retiring wallet after its balance is zero, final incoming settlement and closure charge are complete, and every submitted outflow has settled.", "parameters": { "type": "object", "properties": { "wallet_id": { "type": "string", "description": "wallet id" } }, "required": [ "wallet_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "dust_balance_exit_minimum_outflow_currency_retirement", "service": "px_c_94", "portal": "psp", "applicable_entity": "Local synthetic wallet retirement", "interface_document": "SUPPLEMENT-a913d7fffad8", "rule_documents": [ "SUPPLEMENT-a913d7fffad8" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_cash_intake": { "definition": { "name": "request_cash_intake", "description": "Ask the vault to publish the sealed-bag intake for cash_transaction_id; a scheduled bank event supplies original references and the first independent count.", "parameters": { "type": "object", "properties": { "cash_transaction_id": { "type": "string", "description": "cash transaction id" } }, "required": [ "cash_transaction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery_atm_presentation_retraction_vault_cash_custody", "service": "px_c_89", "portal": "psp", "applicable_entity": "Dedicated synthetic cash network", "interface_document": "SUPPLEMENT-1ea5d55f66f9", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "count_cash_bag": { "definition": { "name": "count_cash_bag", "description": "Obtain the independent denomination count of a published vault bag using counter_name from its licensed_counters. It must differ from the first intake counter.", "parameters": { "type": "object", "properties": { "bag_id": { "type": "string", "description": "bag id" }, "counter_name": { "type": "string", "description": "counter name" } }, "required": [ "bag_id", "counter_name" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery_atm_presentation_retraction_vault_cash_custody", "service": "px_c_89", "portal": "psp", "applicable_entity": "Dedicated synthetic cash network", "interface_document": "SUPPLEMENT-1ea5d55f66f9", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "allocate_recovery_bag": { "definition": { "name": "allocate_recovery_bag", "description": "Associate a counted customer bag with an open cash withdrawal by customer attestation. The immutable original withdrawal reference remains visible; this action cannot change that source fact.", "parameters": { "type": "object", "properties": { "bag_id": { "type": "string", "description": "bag id" }, "cash_transaction_id": { "type": "string", "description": "cash transaction id" } }, "required": [ "bag_id", "cash_transaction_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery_atm_presentation_retraction_vault_cash_custody", "service": "px_c_89", "portal": "psp", "applicable_entity": "Dedicated synthetic cash network", "interface_document": "SUPPLEMENT-1ea5d55f66f9", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "exchange_recovery_notes": { "definition": { "name": "exchange_recovery_notes", "description": "Replace all notes in a counted bag with equal-value denomination_minor notes. Available denominations and quantities are public in denomination_exchange; the vault supplies a new agreeing dual count.", "parameters": { "type": "object", "properties": { "bag_id": { "type": "string", "description": "bag id" }, "denomination_minor": { "type": "integer", "description": "denomination minor (integer minor currency units)" } }, "required": [ "bag_id", "denomination_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery_atm_presentation_retraction_vault_cash_custody", "service": "px_c_89", "portal": "psp", "applicable_entity": "Dedicated synthetic cash network", "interface_document": "SUPPLEMENT-1ea5d55f66f9", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "cash_handover": { "definition": { "name": "cash_handover", "description": "Hand the whole counted and allocated bag to an active identity-checked collector_id. This physically removes notes from vault custody and consumes that withdrawal recovery right; the recipient and original bag reference are immutable.", "parameters": { "type": "object", "properties": { "bag_id": { "type": "string", "description": "bag id" }, "collector_id": { "type": "string", "description": "collector id" } }, "required": [ "bag_id", "collector_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash_delivery_atm_presentation_retraction_vault_cash_custody", "service": "px_c_89", "portal": "psp", "applicable_entity": "Dedicated synthetic cash network", "interface_document": "SUPPLEMENT-1ea5d55f66f9", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_supplier_due_item": { "definition": { "name": "pay_supplier_due_item", "description": "Pay one additional supplier invoice. amount_minor is its contractual net due: the early discount requires an independent completed confirmation, the named account, and both invoices paid by discount_until_minute. Public transfer fees are additional.", "parameters": { "type": "object", "properties": { "item_id": { "type": "string", "description": "item id" }, "account_reference": { "type": "string", "description": "account reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" }, "speed": { "type": "string", "enum": [ "standard", "instant" ], "description": "speed" } }, "required": [ "item_id", "account_reference", "amount_minor", "speed" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_settlement", "service": "linked_due_items", "portal": "psp", "applicable_entity": "supplier due item", "interface_document": "IFACE-SUPPLIER-DUE-ITEM", "rule_documents": [ "SUPPLEMENT-312394df1e63", "SUPPLEMENT-644d9959520e", "IFACE-SUPPLIER-DUE-ITEM" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_staff_float_notice": { "definition": { "name": "request_staff_float_notice", "description": "Request the independent cash-room confirmation of the already-funded staff float. The notice supplies its exact value, collector and note restrictions; it does not create another withdrawal.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "allocation id" } }, "required": [ "allocation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "physical_cash", "service": "staff_float", "portal": "psp", "applicable_entity": "staff float allocation", "interface_document": "IFACE-STAFF-FLOAT", "rule_documents": [ "SUPPLEMENT-1ea5d55f66f9", "SUPPLEMENT-05673bf10a1d", "IFACE-STAFF-FLOAT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "dispense_staff_float": { "definition": { "name": "dispense_staff_float", "description": "Deliver the funded staff float from the same vault denomination inventory used by recovery exchanges. note_counts maps denomination minor units to a positive integer count; customer preferences may be narrower than bank-permitted collectors.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "allocation id" }, "collector_id": { "type": "string", "description": "collector id" }, "note_counts": { "type": "object", "additionalProperties": { "type": "integer", "minimum": 1 }, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "allocation_id", "collector_id", "note_counts" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "vault_denomination_cash_inventory_staff_float_allocation", "service": "px_c_r89", "portal": "psp", "applicable_entity": "Only reasoning_version c-reasoning-v2 records for the current customer and bound original transaction.", "interface_document": "SUPPLEMENT-05673bf10a1d", "rule_documents": [ "SUPPLEMENT-05673bf10a1d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_supplier_calloff_notice": { "definition": { "name": "request_supplier_calloff_notice", "description": "Obtain the supplier notice for the next call-off delivery supported by an existing advance. The bank publishes the actual required units and their existing advance price; this does not pay new cash.", "parameters": { "type": "object", "properties": { "advance_id": { "type": "string", "description": "advance id" } }, "required": [ "advance_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_accounting", "service": "advance_calloff", "portal": "psp", "applicable_entity": "supplier advance", "interface_document": "IFACE-SUPPLIER-CALLOFF", "rule_documents": [ "PX-C-47", "PX-C-R47", "IFACE-SUPPLIER-CALLOFF" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "apply_supplier_advance": { "definition": { "name": "apply_supplier_advance", "description": "Apply amount_minor of the supplier advance to the named restored payable. It consumes an existing asset right rather than bank cash. The separate call-off commitment may still need some of that same right.", "parameters": { "type": "object", "properties": { "advance_id": { "type": "string", "description": "advance id" }, "payable_id": { "type": "string", "description": "payable id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "advance_id", "payable_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_advance_restored_payable_calloff_delivery_allocation", "service": "px_c_r93", "portal": "psp", "applicable_entity": "Only reasoning_version c-reasoning-v2 records for the current customer and bound original transaction.", "interface_document": "PX-C-R47", "rule_documents": [ "PX-C-R47" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reverse_supplier_advance": { "definition": { "name": "reverse_supplier_advance", "description": "Reverse an unfinalized advance application and restore both its supplier asset right and outstanding payable. Applications remain reversible until a supplier call-off delivery is released.", "parameters": { "type": "object", "properties": { "application_id": { "type": "string", "description": "application id" } }, "required": [ "application_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_accounting", "service": "advance_calloff", "portal": "psp", "applicable_entity": "supplier advance", "interface_document": "IFACE-SUPPLIER-CALLOFF", "rule_documents": [ "PX-C-47", "PX-C-R47", "IFACE-SUPPLIER-CALLOFF" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "release_supplier_calloff": { "definition": { "name": "release_supplier_calloff", "description": "Use units of existing supplier advance to release actual next-delivery units at unit_price_minor. Partial releases are permitted and final for those units; unreleased advance remains an asset.", "parameters": { "type": "object", "properties": { "advance_id": { "type": "string", "description": "advance id" }, "units": { "type": "integer", "description": "units" } }, "required": [ "advance_id", "units" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_accounting", "service": "advance_calloff", "portal": "psp", "applicable_entity": "supplier advance", "interface_document": "IFACE-SUPPLIER-CALLOFF", "rule_documents": [ "PX-C-47", "PX-C-R47", "IFACE-SUPPLIER-CALLOFF" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "book_screened_freight": { "definition": { "name": "book_screened_freight", "description": "Book a real carrier departure for the screened supplier consignment. Its nonrefundable charge consumes the same payment account as the goods. Booking does not waive its pickup cutoff.", "parameters": { "type": "object", "properties": { "freight_id": { "type": "string", "description": "freight id" }, "route_id": { "type": "string", "description": "route id" } }, "required": [ "freight_id", "route_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "trade_screening", "service": "freight_booking", "portal": "psp", "applicable_entity": "screened freight consignment", "interface_document": "IFACE-SCREENED-FREIGHT", "rule_documents": [ "SUPPLEMENT-2e4e12273ff0", "SUPPLEMENT-4ee26dfa4a1d", "IFACE-SCREENED-FREIGHT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "dispatch_screened_goods": { "definition": { "name": "dispatch_screened_goods", "description": "Dispatch paid and accepted goods on the selected booking, if its published collection window remains open. The resulting arrival time is fixed by that departure.", "parameters": { "type": "object", "properties": { "booking_id": { "type": "string", "description": "booking id" } }, "required": [ "booking_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "screened_goods_and_carrier_departure_commitments", "service": "px_c_r84", "portal": "psp", "applicable_entity": "Current-customer linked records marked reasoning_version c-reasoning-v2 only.", "interface_document": "SUPPLEMENT-4ee26dfa4a1d", "rule_documents": [ "SUPPLEMENT-4ee26dfa4a1d" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_card_goods_return": { "definition": { "name": "submit_card_goods_return", "description": "Submit a real return against the selected delivered authorization. The notice confirms the returned value and releases only that much cycle occupancy, with a credit to its original account.", "parameters": { "type": "object", "properties": { "return_id": { "type": "string", "description": "return id" }, "authorization_reference": { "type": "string", "description": "authorization reference" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "return_id", "authorization_reference", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "equipment_consumables_and_returned_card_authorization_capacity", "service": "px_c_r86", "portal": "psp", "applicable_entity": "Current-customer linked records marked reasoning_version c-reasoning-v2 only.", "interface_document": "SUPPLEMENT-ea2f3efd3651", "rule_documents": [ "SUPPLEMENT-ea2f3efd3651" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "present_essential_capture": { "definition": { "name": "present_essential_capture", "description": "Present or void an unpresented old-generation essential-service capture. Presentation starts a bank notice; void removes this capture but does not cancel the current merchant invoice.", "parameters": { "type": "object", "properties": { "capture_id": { "type": "string", "description": "capture id" }, "disposition": { "type": "string", "enum": [ "present", "void" ], "description": "disposition" } }, "required": [ "capture_id", "disposition" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "card_network", "service": "capture_lifecycle", "portal": "psp", "applicable_entity": "card capture", "interface_document": "IFACE-NETWORK-CAPTURE", "rule_documents": [ "PX-C-43", "PX-C-R43", "IFACE-NETWORK-CAPTURE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reconcile_essential_capture": { "definition": { "name": "reconcile_essential_capture", "description": "Allocate the actual settled old capture to its own service invoice or retain it as a separate merchant advance. An invoice allocation reduces the subsequent current-generation invoice charge.", "parameters": { "type": "object", "properties": { "capture_id": { "type": "string", "description": "capture id" }, "treatment": { "type": "string", "enum": [ "invoice_offset", "separate_advance" ], "description": "treatment" } }, "required": [ "capture_id", "treatment" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "replacement_generations_and_old_capture_invoice_allocation", "service": "px_c_r87", "portal": "psp", "applicable_entity": "Current-customer linked records marked reasoning_version c-reasoning-v2 only.", "interface_document": "PX-C-R43", "rule_documents": [ "PX-C-R43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_hotel_checkout_notice": { "definition": { "name": "request_hotel_checkout_notice", "description": "Obtain the current legitimate checkout statement for the existing hotel deposit. This statement is distinct from the card terminal currency consent evidence.", "parameters": { "type": "object", "properties": { "deposit_id": { "type": "string", "description": "deposit id" } }, "required": [ "deposit_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "card_travel", "service": "hotel_settlement", "portal": "psp", "applicable_entity": "hotel deposit", "interface_document": "IFACE-HOTEL-SETTLEMENT", "rule_documents": [ "SUPPLEMENT-bb6f914ba77c", "SUPPLEMENT-242deb902122", "IFACE-HOTEL-SETTLEMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_hotel_deposit": { "definition": { "name": "settle_hotel_deposit", "description": "Settle the legitimate checkout amount using bank cash or the existing deposit, and return the remaining deposit as a real cash credit. No conversion claim is included in this calculation.", "parameters": { "type": "object", "properties": { "deposit_id": { "type": "string", "description": "deposit id" }, "method": { "type": "string", "enum": [ "cash", "deposit_offset" ], "description": "method" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "deposit_id", "method", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "hotel_deposits_checkout_bills_and_onward_booking_cash", "service": "px_c_r88", "portal": "psp", "applicable_entity": "Current-customer linked records marked reasoning_version c-reasoning-v2 only.", "interface_document": "SUPPLEMENT-242deb902122", "rule_documents": [ "SUPPLEMENT-242deb902122" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_onward_hotel_booking": { "definition": { "name": "pay_onward_hotel_booking", "description": "Pay a selected onward-stay booking plan from the original card account. The public plan terms state its price and cancellation charge; recipient names identify the actual hotel.", "parameters": { "type": "object", "properties": { "deposit_id": { "type": "string", "description": "deposit id" }, "plan_id": { "type": "string", "description": "plan id" } }, "required": [ "deposit_id", "plan_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "card_travel", "service": "hotel_settlement", "portal": "psp", "applicable_entity": "hotel deposit", "interface_document": "IFACE-HOTEL-SETTLEMENT", "rule_documents": [ "SUPPLEMENT-bb6f914ba77c", "SUPPLEMENT-242deb902122", "IFACE-HOTEL-SETTLEMENT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_retiring_merchant_notice": { "definition": { "name": "request_retiring_merchant_notice", "description": "Retrieve the final amount of an existing merchant authorization tied to the retiring wallets. This creates no new order.", "parameters": { "type": "object", "properties": { "claim_id": { "type": "string", "description": "claim id" } }, "required": [ "claim_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "wallet_exit", "service": "retirement", "portal": "psp", "applicable_entity": "retiring wallet", "interface_document": "IFACE-RETIRING-WALLET", "rule_documents": [ "SUPPLEMENT-a913d7fffad8", "SUPPLEMENT-ffd18286d235", "IFACE-RETIRING-WALLET" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_retiring_merchant": { "definition": { "name": "settle_retiring_merchant", "description": "Pay the actual retiring-wallet merchant bill, plus any explicitly chosen gratuity, in an accepted currency. USD payment uses its published conversion and collection fee.", "parameters": { "type": "object", "properties": { "claim_id": { "type": "string", "description": "claim id" }, "currency": { "type": "string", "enum": [ "EUR", "USD" ], "description": "currency" }, "merchant_amount_eur_minor": { "type": "integer", "description": "merchant amount eur minor (integer minor currency units)" } }, "required": [ "claim_id", "currency", "merchant_amount_eur_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "retiring_wallet_merchant_claims_and_final_net_exit", "service": "px_c_r94", "portal": "psp", "applicable_entity": "Current customer linked records with reasoning_version c-reasoning-v2.", "interface_document": "SUPPLEMENT-ffd18286d235", "rule_documents": [ "SUPPLEMENT-ffd18286d235" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "finance_institution_receivable": { "definition": { "name": "finance_institution_receivable", "description": "Assign the institutional receivable without recourse, draw its offered credit line, or collect it at maturity. Assignment consumes the receivable; a credit line preserves it and creates real repayable principal.", "parameters": { "type": "object", "properties": { "finance_id": { "type": "string", "description": "finance id" }, "method": { "type": "string", "enum": [ "nonrecourse_assignment", "credit_line", "collection" ], "description": "method" } }, "required": [ "finance_id", "method" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "institution_finance", "service": "receivable_payroll", "portal": "psp", "applicable_entity": "institution finance case", "interface_document": "IFACE-INSTITUTION-FINANCE", "rule_documents": [ "SUPPLEMENT-b3f22e7841bc", "SUPPLEMENT-716465a2e0fa", "IFACE-INSTITUTION-FINANCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_institution_payroll": { "definition": { "name": "pay_institution_payroll", "description": "Pay institution employees from institution-owned operating cash. The actual payment minute remains visible even when submitted after the contractual due time.", "parameters": { "type": "object", "properties": { "finance_id": { "type": "string", "description": "finance id" } }, "required": [ "finance_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "institution_finance", "service": "receivable_payroll", "portal": "psp", "applicable_entity": "institution finance case", "interface_document": "IFACE-INSTITUTION-FINANCE", "rule_documents": [ "SUPPLEMENT-b3f22e7841bc", "SUPPLEMENT-716465a2e0fa", "IFACE-INSTITUTION-FINANCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "repay_institution_credit": { "definition": { "name": "repay_institution_credit", "description": "Repay drawn institutional credit principal from real operating cash. This does not forgive a remaining balance.", "parameters": { "type": "object", "properties": { "finance_id": { "type": "string", "description": "finance id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "finance_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "institution_finance", "service": "receivable_payroll", "portal": "psp", "applicable_entity": "institution finance case", "interface_document": "IFACE-INSTITUTION-FINANCE", "rule_documents": [ "SUPPLEMENT-b3f22e7841bc", "SUPPLEMENT-716465a2e0fa", "IFACE-INSTITUTION-FINANCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "assign_residual_receivable": { "definition": { "name": "assign_residual_receivable", "description": "Assign only the actual remaining undisputed debtor tranche to the selected nonrecourse factor. The factor fee is deducted from its cash advance and the transferred claim can no longer be collected.", "parameters": { "type": "object", "properties": { "tranche_id": { "type": "string", "description": "tranche id" }, "factor_id": { "type": "string", "description": "factor id" } }, "required": [ "tranche_id", "factor_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "partial_debtor_collections_and_nonrecourse_residual_assignments", "service": "px_c_r98", "portal": "psp", "applicable_entity": "Current customer linked records with reasoning_version c-reasoning-v2.", "interface_document": "PX-C-R48", "rule_documents": [ "PX-C-R48" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "collect_later_debtor_tranche": { "definition": { "name": "collect_later_debtor_tranche", "description": "Collect the still-owned remainder at its contractual later date. An assigned tranche cannot also be collected.", "parameters": { "type": "object", "properties": { "tranche_id": { "type": "string", "description": "tranche id" } }, "required": [ "tranche_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "later_debtor_tranche_collection", "service": "iface_debtor_tranche", "portal": "psp", "applicable_entity": "PSP product accounts; Collection of later debtor tranches after their published availability conditions are met.", "interface_document": "IFACE-DEBTOR-TRANCHE", "rule_documents": [ "IFACE-DEBTOR-TRANCHE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "fund_wallet_payroll": { "definition": { "name": "fund_wallet_payroll", "description": "Transfer explicit operating cash into the payroll wallet, charging the disclosed manual funding fee. This is separate from configured automatic topups.", "parameters": { "type": "object", "properties": { "payroll_id": { "type": "string", "description": "payroll id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "payroll_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "wallet_operations", "service": "payroll", "portal": "psp", "applicable_entity": "payroll wallet", "interface_document": "IFACE-WALLET-PAYROLL", "rule_documents": [ "PX-C-50", "IFACE-WALLET-PAYROLL" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "settle_wallet_payroll": { "definition": { "name": "settle_wallet_payroll", "description": "Pay the actual payroll notice from the wallet at its current controller cycle. A late bank-accepted payment retains its true execution cycle.", "parameters": { "type": "object", "properties": { "payroll_id": { "type": "string", "description": "payroll id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "payroll_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "wallet_payroll_batches_and_post_capture_operating_bands", "service": "px_c_r100", "portal": "psp", "applicable_entity": "Current customer linked records with reasoning_version c-reasoning-v2.", "interface_document": "PX-C-R50", "rule_documents": [ "PX-C-R50" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_cod_return_notice": { "definition": { "name": "request_cod_return_notice", "description": "Obtain the accepted return attached to the original buyer order; the carrier will publish actual refundable value.", "parameters": { "type": "object", "properties": { "return_id": { "type": "string", "description": "return id" } }, "required": [ "return_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_cod", "service": "return_settlement", "portal": "psp", "applicable_entity": "carrier return", "interface_document": "IFACE-CARRIER-COD-RETURN", "rule_documents": [ "PX-C-44", "PX-C-R44", "IFACE-CARRIER-COD-RETURN" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "select_cod_return_channel": { "definition": { "name": "select_cod_return_channel", "description": "Choose carrier net remittance or merchant cash refund for the accepted buyer return before carrier cash is remitted.", "parameters": { "type": "object", "properties": { "return_id": { "type": "string", "description": "return id" }, "channel": { "type": "string", "enum": [ "net_remittance", "cash_refund" ], "description": "channel" } }, "required": [ "return_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_cod", "service": "return_settlement", "portal": "psp", "applicable_entity": "carrier return", "interface_document": "IFACE-CARRIER-COD-RETURN", "rule_documents": [ "PX-C-44", "PX-C-R44", "IFACE-CARRIER-COD-RETURN" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "send_cod_buyer_refund": { "definition": { "name": "send_cod_buyer_refund", "description": "Send a direct merchant refund to a delivered buyer. The bank validates its prior collected limit; the caller must separately reconcile the original accepted return and any carrier offset.", "parameters": { "type": "object", "properties": { "return_id": { "type": "string", "description": "return id" }, "order_id": { "type": "string", "description": "order id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "return_id", "order_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_cod", "service": "return_settlement", "portal": "psp", "applicable_entity": "carrier return", "interface_document": "IFACE-CARRIER-COD-RETURN", "rule_documents": [ "PX-C-44", "PX-C-R44", "IFACE-CARRIER-COD-RETURN" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_cod_replenishment": { "definition": { "name": "pay_cod_replenishment", "description": "Pay the replenishment invoice from the same carrier-proceeds account. A valid partial amount reduces the still-open invoice but does not settle the rest.", "parameters": { "type": "object", "properties": { "return_id": { "type": "string", "description": "return id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "return_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "carrier_cod", "service": "return_settlement", "portal": "psp", "applicable_entity": "carrier return", "interface_document": "IFACE-CARRIER-COD-RETURN", "rule_documents": [ "PX-C-44", "PX-C-R44", "IFACE-CARRIER-COD-RETURN" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "refund_prior_tax_overcollection": { "definition": { "name": "refund_prior_tax_overcollection", "description": "Refund a prior-period tax overcollection through the bank or card processor. Both routes return the entire entered amount; processor costs are separate. The authority review follows the actual refund.", "parameters": { "type": "object", "properties": { "refund_id": { "type": "string", "description": "refund id" }, "recipient": { "type": "string", "description": "recipient" }, "route": { "type": "string", "enum": [ "bank", "card_processor" ], "description": "route" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "refund_id", "recipient", "route", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "sales_tax", "service": "refund_credit", "portal": "psp", "applicable_entity": "tax refund case", "interface_document": "IFACE-TAX-REFUND-CREDIT", "rule_documents": [ "PX-C-45", "PX-C-R45", "IFACE-TAX-REFUND-CREDIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "allocate_generated_tax_credit": { "definition": { "name": "allocate_generated_tax_credit", "description": "Assign the independently certified tax refund credit to CURRENT remittance or preserve it as CARRY_FORWARD. Only the certified jurisdiction may use it.", "parameters": { "type": "object", "properties": { "refund_id": { "type": "string", "description": "refund id" }, "period": { "type": "string", "enum": [ "CURRENT", "CARRY_FORWARD" ], "description": "period" }, "jurisdiction": { "type": "string", "description": "jurisdiction" } }, "required": [ "refund_id", "period", "jurisdiction" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "sales_tax", "service": "refund_credit", "portal": "psp", "applicable_entity": "tax refund case", "interface_document": "IFACE-TAX-REFUND-CREDIT", "rule_documents": [ "PX-C-45", "PX-C-R45", "IFACE-TAX-REFUND-CREDIT" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_treasury_redemption": { "definition": { "name": "submit_treasury_redemption", "description": "Commit the encumbered deposit to standard or accelerated redemption. The selected fee and due date are final; the independent notice releases the actual held amount.", "parameters": { "type": "object", "properties": { "distribution_id": { "type": "string", "description": "distribution id" }, "channel": { "type": "string", "enum": [ "standard", "accelerated" ], "description": "channel" } }, "required": [ "distribution_id", "channel" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "treasury_statement", "service": "distribution_settlement", "portal": "psp", "applicable_entity": "statement distribution", "interface_document": "IFACE-STATEMENT-DISTRIBUTION", "rule_documents": [ "PX-C-46", "PX-C-R46", "IFACE-STATEMENT-DISTRIBUTION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_statement_supported_distribution": { "definition": { "name": "pay_statement_supported_distribution", "description": "Pay an installment of the owner distribution or supplier invoice using unencumbered cash. The owner amount derives from actual consolidated external income; supplier settlement can claim its public early discount or pay full face.", "parameters": { "type": "object", "properties": { "distribution_id": { "type": "string", "description": "distribution id" }, "obligation": { "type": "string", "enum": [ "OWNER", "SUPPLIER" ], "description": "obligation" }, "account_id": { "type": "string", "description": "account id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" }, "supplier_terms": { "type": "string", "enum": [ "early_discount", "full_face" ], "description": "supplier terms" } }, "required": [ "distribution_id", "obligation", "account_id", "amount_minor", "supplier_terms" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "treasury_statement", "service": "distribution_settlement", "portal": "psp", "applicable_entity": "statement distribution", "interface_document": "IFACE-STATEMENT-DISTRIBUTION", "rule_documents": [ "PX-C-46", "PX-C-R46", "IFACE-STATEMENT-DISTRIBUTION" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "reserve_fallback_capacity": { "definition": { "name": "reserve_fallback_capacity", "description": "Reserve amount_minor of currently free standard-fallback principal for one batch item; the posted reservation fee is nonrefundable. A zero amount releases its unused reservation without a fee refund.", "parameters": { "type": "object", "properties": { "capacity_id": { "type": "string", "description": "capacity id" }, "item_id": { "type": "string", "description": "item id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "capacity_id", "item_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "fallback_capacity_and_original_channel_settlement_windows", "service": "px_c_r96", "portal": "psp", "applicable_entity": "Synthetic linked contracts for the current customer with reasoning_version c-reasoning-v2.", "interface_document": "SUPPLEMENT-13f05c805b95", "rule_documents": [ "SUPPLEMENT-13f05c805b95" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "draw_currency_release_bridge": { "definition": { "name": "draw_currency_release_bridge", "description": "Advance same-currency principal against the still-active deferred reservation after its first release notice. amount_minor cannot exceed remaining collateral. The posted fee is paid from coordination cash; loan principal must later be repaid.", "parameters": { "type": "object", "properties": { "release_id": { "type": "string", "description": "release id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" } }, "required": [ "release_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "currency_reservation", "service": "release_bridge", "portal": "psp", "applicable_entity": "deferred currency release", "interface_document": "IFACE-CURRENCY-RELEASE-BRIDGE", "rule_documents": [ "SUPPLEMENT-16c3248a3271", "SUPPLEMENT-1b7227025924", "IFACE-CURRENCY-RELEASE-BRIDGE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "repay_currency_release_bridge": { "definition": { "name": "repay_currency_release_bridge", "description": "Repay the outstanding bridge from unreserved cash in its original currency after releases make that cash available. Full principal is required.", "parameters": { "type": "object", "properties": { "release_id": { "type": "string", "description": "release id" } }, "required": [ "release_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "currency_reservation", "service": "release_bridge", "portal": "psp", "applicable_entity": "deferred currency release", "interface_document": "IFACE-CURRENCY-RELEASE-BRIDGE", "rule_documents": [ "SUPPLEMENT-16c3248a3271", "SUPPLEMENT-1b7227025924", "IFACE-CURRENCY-RELEASE-BRIDGE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "remit_second_supplier_installment": { "definition": { "name": "remit_second_supplier_installment", "description": "Pay amount_minor toward the enrolled second supplier using economical, conservative or premium. Economical consumes shared certified quota; conservative has the public per-ticket ceiling and fee formula. fee_bearer is SENDER or SHARED, and correspondent cost applies only to the first installment. Bank permits excess remittance; it does not amend the supplier invoice.", "parameters": { "type": "object", "properties": { "portfolio_id": { "type": "string", "description": "portfolio id" }, "amount_minor": { "type": "integer", "description": "amount minor (integer minor currency units)" }, "route": { "type": "string", "enum": [ "economical", "conservative", "premium" ], "description": "route" }, "fee_bearer": { "type": "string", "enum": [ "SENDER", "SHARED" ], "description": "fee bearer" } }, "required": [ "portfolio_id", "amount_minor", "route", "fee_bearer" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "supplier_settlement", "service": "split_remittance", "portal": "psp", "applicable_entity": "supplier portfolio", "interface_document": "IFACE-SUPPLIER-SPLIT-REMITTANCE", "rule_documents": [ "PX-C-49", "PX-C-R49", "IFACE-SUPPLIER-SPLIT-REMITTANCE" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_cash_store_attestation": { "definition": { "name": "request_cash_store_attestation", "description": "Ask the external cash-store network for the actual acceptance of an existing barcode. The attestation fee is charged once and a delayed signed result names cash amount, time and code. Revocation or expiry never destroys cash already accepted while valid.", "parameters": { "type": "object", "properties": { "barcode_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "barcode_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cash_barcode_store_voucher_offline_redemption", "service": "px_d_42", "portal": "psp", "applicable_entity": "External cash gateway orders", "interface_document": "PX-D-42", "rule_documents": [ "PX-D-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "revoke_external_cash_barcode": { "definition": { "name": "revoke_external_cash_barcode", "description": "Request external-network revocation of a code. The old code remains valid until the revocation acknowledgement or its expiry. An offline cash acceptance before either boundary remains payable even after revocation.", "parameters": { "type": "object", "properties": { "barcode_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "barcode_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cash_barcode_store_voucher_offline_redemption", "service": "px_d_42", "portal": "psp", "applicable_entity": "External cash gateway orders", "interface_document": "PX-D-42", "rule_documents": [ "PX-D-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "issue_external_cash_barcode": { "definition": { "name": "issue_external_cash_barcode", "description": "Issue a new fixed-value external-store barcode for an order, network and expiry minute. face_minor is the cash buyer will tender, not PSP net proceeds. Issuing another code does not invalidate earlier codes or prove no earlier cash was collected. The network fee is debited immediately.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "network_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "face_minor": { "type": "integer", "minimum": 0, "description": "Use integer minor currency units derived from the current obligation and the published business rules." }, "expiry_minute": { "type": "integer", "minimum": 0, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "order_id", "network_id", "face_minor", "expiry_minute" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cash_barcode_store_voucher_offline_redemption", "service": "px_d_42", "portal": "psp", "applicable_entity": "External cash gateway orders", "interface_document": "PX-D-42", "rule_documents": [ "PX-D-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "present_external_cash_barcode": { "definition": { "name": "present_external_cash_barcode", "description": "Send an issued code to the genuine buyer for cash payment at the stated network. This schedules an actual cash tender; a second presented code can collect the same commercial order twice. The store tests the code at its actual tender time.", "parameters": { "type": "object", "properties": { "barcode_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "barcode_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cash_barcode_store_voucher_offline_redemption", "service": "px_d_42", "portal": "psp", "applicable_entity": "External cash gateway orders", "interface_document": "PX-D-42", "rule_documents": [ "PX-D-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "redeem_accepted_cash_ticket": { "definition": { "name": "redeem_accepted_cash_ticket", "description": "Submit a signed store ticket for final PSP settlement to its bound merchant. A ticket can be redeemed only once, including one from a revoked old barcode. Store cash accepted and bank proceeds are separate states.", "parameters": { "type": "object", "properties": { "ticket_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "ticket_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cash_barcode_store_voucher_offline_redemption", "service": "px_d_42", "portal": "psp", "applicable_entity": "External cash gateway orders", "interface_document": "PX-D-42", "rule_documents": [ "PX-D-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "record_cash_order_clearance": { "definition": { "name": "record_cash_order_clearance", "description": "Publish one commercial order’s actual store cash and PSP settlement receipts. Positive store acceptance is not final bank settlement. Publication preserves the list of all genuine tickets, including duplicates.", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "order_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "cash_barcode_store_voucher_offline_redemption", "service": "px_d_42", "portal": "psp", "applicable_entity": "External cash gateway orders", "interface_document": "PX-D-42", "rule_documents": [ "PX-D-42" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "pay_serial_code_package": { "definition": { "name": "pay_serial_code_package", "description": "Pay the catalog package principal to the listed serialized-code provider. The actual settled package determines quantity, product-family restrictions, serial identity and refund terms. A proposed payment creates no code rights.", "parameters": { "type": "object", "properties": { "package_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "package_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "transparency_serial_code_fee_package_product_batch_activation_refund", "service": "px_d_43", "portal": "psp", "applicable_entity": "Orchard Serialized Services contracts", "interface_document": "PX-D-43", "rule_documents": [ "PX-D-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "bind_serial_code_range": { "definition": { "name": "bind_serial_code_range", "description": "Bind units from a settled serial lot to a listed product. The lot’s serial interval is divided without copying identifiers. Family compatibility is a commercial obligation, while the bank allocation interface accepts listed products. A binding can be released only before export.", "parameters": { "type": "object", "properties": { "lot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "product_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "units": { "type": "integer", "minimum": 0, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "lot_id", "product_id", "units" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "transparency_serial_code_fee_package_product_batch_activation_refund", "service": "px_d_43", "portal": "psp", "applicable_entity": "Orchard Serialized Services contracts", "interface_document": "PX-D-43", "rule_documents": [ "PX-D-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "release_unexported_serial_binding": { "definition": { "name": "release_unexported_serial_binding", "description": "Release an unexported binding and restore those exact serial intervals to the available lot. This never restores exported or activated rights.", "parameters": { "type": "object", "properties": { "binding_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "binding_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "transparency_serial_code_fee_package_product_batch_activation_refund", "service": "px_d_43", "portal": "psp", "applicable_entity": "Orchard Serialized Services contracts", "interface_document": "PX-D-43", "rule_documents": [ "PX-D-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "export_serial_code_binding": { "definition": { "name": "export_serial_code_binding", "description": "Export the allocated serial binding to a production batch. This permanently binds product genealogy and batch, removes refund eligibility and cannot be undone by later master-data edits. The supplied batch must exist but the commercial product/batch compatibility remains the caller’s responsibility.", "parameters": { "type": "object", "properties": { "binding_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "batch_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "binding_id", "batch_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "transparency_serial_code_fee_package_product_batch_activation_refund", "service": "px_d_43", "portal": "psp", "applicable_entity": "Orchard Serialized Services contracts", "interface_document": "PX-D-43", "rule_documents": [ "PX-D-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "activate_serial_code_binding": { "definition": { "name": "activate_serial_code_binding", "description": "Activate all codes in one exported range. Activation is irreversible and does not silently change a product revision, batch or quantity. Only actually activated serials protect the specified production batch.", "parameters": { "type": "object", "properties": { "binding_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "binding_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "transparency_serial_code_fee_package_product_batch_activation_refund", "service": "px_d_43", "portal": "psp", "applicable_entity": "Orchard Serialized Services contracts", "interface_document": "PX-D-43", "rule_documents": [ "PX-D-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "refund_unexported_serial_units": { "definition": { "name": "refund_unexported_serial_units", "description": "Surrender unbound available units for the lot’s published per-unit refund. Surrender consumes the serial rights permanently; zero-rate packages return no cash. Bound units must first be released, and exported units cannot be refunded.", "parameters": { "type": "object", "properties": { "lot_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." }, "units": { "type": "integer", "minimum": 0, "description": "Use the value established by the applicable business record, customer fact, or prior service receipt." } }, "required": [ "lot_id", "units" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "transparency_serial_code_fee_package_product_batch_activation_refund", "service": "px_d_43", "portal": "psp", "applicable_entity": "Orchard Serialized Services contracts", "interface_document": "PX-D-43", "rule_documents": [ "PX-D-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "publish_serial_rights_statement": { "definition": { "name": "publish_serial_rights_statement", "description": "Publish paid packages, actual active product/batch rights and surrendered units. It does not alter product lineage or convert an exported code into a refundable one.", "parameters": { "type": "object", "properties": { "contract_id": { "type": "string", "description": "Obtain the exact identifier from the applicable business record or a prior service receipt; do not ask the customer to invent an internal ID." } }, "required": [ "contract_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "transparency_serial_code_fee_package_product_batch_activation_refund", "service": "px_d_43", "portal": "psp", "applicable_entity": "Orchard Serialized Services contracts", "interface_document": "PX-D-43", "rule_documents": [ "PX-D-43" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "request_payment_prerequisite_review": { "definition": { "name": "request_payment_prerequisite_review", "description": "Request verification of one current payment prerequisite, such as beneficiary instructions, screening, a government reference, a fee election or an authorization version. The request schedules the recorded review result; requesting it is not approval.", "parameters": { "type": "object", "properties": { "control_id": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." } }, "required": [ "control_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "external_payment_lifecycle", "service": "payment_v9_lifecycle", "portal": "psp", "applicable_entity": "Versioned external payment obligations", "interface_document": "PAY-V9-LIFECYCLE", "rule_documents": [ "PAY-V9-LIFECYCLE", "PAY-V9-CONTROLS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "allocate_payment_funds": { "definition": { "name": "allocate_payment_funds", "description": "Reserve an amount from one recorded funding source for one payment obligation. Allocation does not move money and does not waive source-purpose, value-date, reserve or safeguarding restrictions.", "parameters": { "type": "object", "properties": { "obligation_id": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." }, "source_id": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." }, "amount_minor": { "type": "integer", "minimum": 1, "description": "Use the exact value from the applicable ordinary business record or service receipt." } }, "required": [ "obligation_id", "source_id", "amount_minor" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "external_payment_lifecycle", "service": "payment_v9_lifecycle", "portal": "psp", "applicable_entity": "Versioned external payment obligations", "interface_document": "PAY-V9-LIFECYCLE", "rule_documents": [ "PAY-V9-LIFECYCLE", "PAY-V9-CONTROLS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "cancel_payment_allocation": { "definition": { "name": "cancel_payment_allocation", "description": "Release one unsubmitted payment allocation. Submitted or settled payment exposure must be recalled instead and any external fee remains real.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." } }, "required": [ "allocation_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "external_payment_lifecycle", "service": "payment_v9_lifecycle", "portal": "psp", "applicable_entity": "Versioned external payment obligations", "interface_document": "PAY-V9-LIFECYCLE", "rule_documents": [ "PAY-V9-LIFECYCLE", "PAY-V9-CONTROLS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "submit_external_payment": { "definition": { "name": "submit_external_payment", "description": "Submit an allocated payment using an explicit beneficiary-instruction version, fee bearer and reference version. The interface accepts recorded versions and sources even when they are commercially stale or restricted; the caller must apply the published payment policy. Submission debits cash and creates external exposure immediately.", "parameters": { "type": "object", "properties": { "allocation_id": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." }, "beneficiary_version": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." }, "charge_bearer": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." }, "reference_version": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." } }, "required": [ "allocation_id", "beneficiary_version", "charge_bearer", "reference_version" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "external_payment_lifecycle", "service": "payment_v9_lifecycle", "portal": "psp", "applicable_entity": "Versioned external payment obligations", "interface_document": "PAY-V9-LIFECYCLE", "rule_documents": [ "PAY-V9-LIFECYCLE", "PAY-V9-CONTROLS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "recall_external_payment": { "definition": { "name": "recall_external_payment", "description": "Request recall of one submitted, accepted or settled external payment. Recall cannot erase the original exposure or its fees. The recorded recall outcome and net cash return arrive asynchronously.", "parameters": { "type": "object", "properties": { "payment_id": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." } }, "required": [ "payment_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "external_payment_lifecycle", "service": "payment_v9_lifecycle", "portal": "psp", "applicable_entity": "Versioned external payment obligations", "interface_document": "PAY-V9-LIFECYCLE", "rule_documents": [ "PAY-V9-LIFECYCLE", "PAY-V9-CONTROLS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" }, "publish_payment_case_reconciliation": { "definition": { "name": "publish_payment_case_reconciliation", "description": "Publish the case reconciliation from actual payment, return, recall and control records. Publication does not repair a wrong beneficiary, duplicate exposure, stale authorization, restricted source use or missed deadline.", "parameters": { "type": "object", "properties": { "case_id": { "type": "string", "description": "Use the exact value from the applicable ordinary business record or service receipt." } }, "required": [ "case_id" ], "additionalProperties": false }, "read_only": false, "approval_required": true, "business_area": "external_payment_lifecycle", "service": "payment_v9_lifecycle", "portal": "psp", "applicable_entity": "Versioned external payment obligations", "interface_document": "PAY-V9-LIFECYCLE", "rule_documents": [ "PAY-V9-LIFECYCLE", "PAY-V9-CONTROLS" ], "schema_source": "frozen executable catalog and canonical business-service manual", "product_scope": "psp", "execution_protocol": "unified-payment-request-v1" }, "product_scope": "psp" } }