Fiserv
Process payments, manage disputes, board merchants and reconcile fundings using Fiserv EMEA (ecommerce + omnichannel/AQaaS) APIs.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 115 actions:
| Action | Purpose | Parameters |
|---|---|---|
| public/checkouts/post_checkouts | Initiate a payment request by passing all the required parameters. It creates a new payment transaction and returns the redirect URL that includes transaction ID. | Client-Request-Id (string) required Message-Signature (string) required Timestamp (string) required data: { . storeId (string) . merchantTransactionId (string) . transactionOrigin (string) . transactionType (string) . transactionAmount . order . checkoutSettings . paymentMethodDetails } (object) required |
| public/checkouts/get_checkouts_by_checkout_id | Retrieve details about a specific checkout using the identifier returned when it was created. | checkoutId (string) |
| public/disputes/get_disputes | Search for Disputes. | Institution-Number (string) acquirerReferenceNumber (string) from (string) to (string) limit (integer) offset (integer) visaId (string) mastercardId (string) orderId (string) status (string) sort (string) merchantId (string) stage (array) |
| public/disputes/get_disputes_by_dispute_id | Get Dispute by ID | disputeId (string) |
| public/disputes/get_disputes_by_dispute_id_documents_by_document_id | Get document by ID for a given Dispute ID | disputeId (string) documentId (string) Accept (string) required |
| public/disputes/post_disputes_by_dispute_id_events_by_event_id_actions | Execute an Action against this Dispute | disputeId (string) eventId (string) Institution-Number (string) Message-Signature (string) required |
| public/disputes/post_disputes_by_dispute_id_actions_by_action_id_undo | Undo an Action | disputeId (string) actionId (string) Institution-Number (string) Message-Signature (string) required data: { . tcn (string) } (object) required |
| public/disputes/post_disputes_by_dispute_id_notes | Add a new note to a Dispute to provide more detail and information. | disputeId (string) Institution-Number (string) Message-Signature (string) required data: { . tcn . content (string) . userName (string) } (object) required |
| public/disputes/post_disputes_by_dispute_id_document | This endpoint can be used to attach additional documents to the Dispute Case. One document per API call is allowed. | disputeId (string) |
| public/financial_adjustments/post_post_adjustment | Submit fees and adjustments to merchant accounts to be considered on the merchant payment or collection. | Message-Signature (string) required Institution-Number (string) data: { . adjustmentCategory (string) . adjustmentTypeIndex (string) . merchantId (string) . accountNumber (string) . amount (string) . currency (string) . date (string) . description (string) . feeSequenceCode (string) . originalTransactionArn (string) . quantity (string) } (object) required |
| public/financial_adjustments/put_modify_adjustment | Modify an adjustment that has been created. Modifying adjustment is allowed only prior to it is picked up for processing i.e. modify an adjustment is allowed if the status of adjustment is NOT in 'Released' and 'Cancelled'. Single adjustment modification per API call is allowed. | Message-Signature (string) required Institution-Number (string) data: { . adjustmentSlipNumber (string) . adjustmentCategory (string) . adjustmentTypeIndex (string) . merchantId (string) . accountNumber (string) . amount (string) . currency (string) . date (string) . description (string) . feeSequenceCode (string) . originalTransactionArn (string) . quantity (string) } (object) required |
| public/financial_adjustments/delete_cancel_adjustment | Cancel an adjustment. Cancelling an adjustment is allowed only prior to it is picked up for processing i.e. cancel an adjustment is allowed if the status of adjustment is NOT in 'Released' and 'Cancelled'. One adjustment cancellation per API call is allowed. | Message-Signature (string) required Institution-Number (string) data: { . adjustmentSlipNumber (string) } (object) required |
| public/financial_adjustments/get_get_adjustments_staged | Retrieve list of adjustments that are stagged. | Institution-Number (string) adjustmentSlipNumber (string) batchSlipNumber (string) merchantId (string) adjustmentStatus (string) adjustmentCategory (string) adjustmentTypeIndex (string) dateFrom (string) dateTo (string) limit (integer) offset (integer) |
| public/financial_adjustments/get_reference_data | Returns a list of valid values for the requested classification for an institution. | Institution-Number (string) classification (string) |
| public/funding_rejects/get_funding_rejects | Retrieves a paginated list of funding rejects. The results can be fitered by any one or more query parameters passed as input in the API Request. | Institution-Number (string) merchantId (string) status (string) rejectedAfter (string) rejectedBefore (string) offset (integer) limit (integer) sort (string) fundingId (string) |
| public/funding_rejects/patch_funding_rejects | This operation allows to modify Funding Reject statuses for a list of funding ids. | Institution-Number (string) Message-Signature (string) required data (array) required |
| public/payment_links/post_payment_links | Create a payment link by passing the required parameters. This link can then be passed on to the end consumer to direct them to a checkout page. Redirect URLs are not applicable for Payment Links. Do not use this field when creating Payment Link requests. The payment result is displayed directly on the checkout page. | Client-Request-Id (string) required Message-Signature (string) required Timestamp (string) required data: { . storeId . merchantTransactionId . transactionOrigin . transactionType . transactionAmount . order . checkoutSettings . paymentMethodDetails . paymentLinkDetails } (object) required |
| public/payment_links/get_payment_links_by_payment_link_id | Retrieve payment link details by sending the payment link id as a URI parameter to the endpoint. Payment link id is generated along with the payment link. | paymentLinkId (string) data: { } (object) required |
| public/payments/post_payments | Use this to originate a financial transaction like a sale, preauthorization, or credit. | Content-Type (string) required Client-Request-Id (string) required Message-Authentication-Value (string) Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (object) required |
| public/payments/get_payments_by_transaction_id | Use this query to get the current state of an existing transaction. | transaction-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) |
| public/payments/patch_payments_by_transaction_id | Use this to handle a redirect response, updating the transaction and continuing processing. | transaction-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (object) required |
| public/payments/post_payments_by_transaction_id | Use this to perform a subsequent transaction, e.g. void, postAuth or return. | transaction-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) data (undefined) required |
| public/payments/patch_payments_action_by_transaction_id | Perform an update on an existing transaction. This function is only applicable for an existing preAuth transaction. | transaction-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (undefined) required |
| public/payments/post_payments_apm_by_transaction_id | Use this to perform an action on an existing transaction. | transaction-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) data (undefined) required |
| public/payments/patch_payments_apm_by_transaction_id | Perform an action on an existing APM transaction. | transaction-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (undefined) required |
| public/payments/post_orders_by_order_id | Use this to perform a subsequent transaction, e.g. postAuth or return using an order ID as a reference. | order-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (undefined) required |
| public/payments/get_orders_by_order_id | Use this query to get the current state of an existing order. | order-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) |
| public/payments/post_payment_schedules | Use this to create a payment schedule managed by the gateway. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (undefined) required |
| public/payments/get_payment_schedules_by_order_id | Use this to view details of a payment schedule managed by the gateway. | order-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) |
| public/payments/delete_payment_schedules_by_order_id | Use this to cancel a payment schedule managed by the gateway. | order-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) |
| public/payments/patch_payment_schedules_by_order_id | Use this to update a payment schedule managed by the gateway. | order-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (object) required |
| public/payments/post_payment_url | Use this to generate a payment link. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (undefined) required |
| public/payments/delete_payment_url | Use this to delete a payment link. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) transactionId (string) orderId (string) paymentUrlId (string) transactionTime (string) |
| public/payments/get_payment_url | Use this query to get the current state of an existing paymentURL. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required storeId (string) orderId (string) merchantTransactionId (string) fromDate (string) required toDate (string) required status (string) |
| public/payments/post_payment_tokens | Use this to create a payment token to safely store sensitive credit card information. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required Authorization (string) data (object) required |
| public/payments/patch_payment_tokens | Use this update one or more payment tokens. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required Authorization (string) data (undefined) required |
| public/payments/get_payment_tokens_by_token_id | Get payment card details associated with token. | token-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required Authorization (string) storeId (string) payment-method (undefined) |
| public/payments/delete_payment_tokens_by_token_id | Use this to delete a payment token. | token-id (string) Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required Authorization (string) storeId (string) payment-method (undefined) |
| public/payments/post_card_verification | Use this to perform card verification for a payment card. Use the account-verification endpoint instead for this request. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (undefined) required |
| public/payments/post_account_verification | Use this to perform an account verification for a payment card or payment token | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (object) required |
| public/payments/post_exchange_rates | Sale, return and lookup exchange rate with dynamic currency conversion option | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (object) required |
| public/payments/post_card_information | Use this to look up card related information such as issuer country, card function and card brand. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (undefined) required |
| public/payments/post_account_information | Use this to look up card related information associated with a payment card or payment token. | Content-Type (string) required Client-Request-Id (string) required Api-Key (string) required Timestamp (integer) required Message-Signature (string) required data (object) required |
| public/sca_exemptions/post_sca_exemptions | Evaluate transaction for SCA exemption. This endpoint is the first one you use to understand if you should move the user through SCA. | FSV-Interaction-Id (string) required Timestamp (integer) required FSV-Idempotency-Key (string) required Message-Signature (string) required data: { . transactionDetails (object) } (object) required |
| public/sca_exemptions/post_sca_exemptions_data | Provide data to SCA exemption engine for learning purposes note this will not generate a risk score. | FSV-Interaction-Id (string) required Timestamp (integer) required FSV-Idempotency-Key (string) required Message-Signature (string) required data: { . transactionDetails . transactionResponseDetails } (object) required |
| public/statements/get_statements | List Statements for a given alliance or merchant within a created date range. | createdAfter (string) createdBefore (string) Merchant-Id (string) documentNumber (string) offset (integer) limit (integer) |
| public/statements/get_statements_by_id | Get Statement by ID including the PDF content base64 encoded. | id (string) |
| public/transactional_data/get_authorisations | Return a list of all authorisations, restricted by your allianceCode, partnerCode or merchant ID as appropriate for the given datetime range. | createdAfter (string) createdBefore (string) limit (undefined) offset (undefined) sort (undefined) Partner-Code (string) Merchant-Id (string) storeId (string) terminalId (string) orderId (string) |
| public/transactional_data/get_authorisations_by_id | Returns single Authorisation for the given unique ID | id (string) |
| public/transactional_data/get_authorisations_authorisation_summaries | Return a list of all authorisation summaries for the days within the given date range, restricted by your allianceCode, partnerCode or merchant ID as appropriate. | createdAfter (string) createdBefore (string) limit (undefined) offset (undefined) Partner-Code (string) Merchant-Id (string) |
| public/transactional_data/get_transactions | Return a list of all transactions, restricted by your allianceCode, partnerCode or merchant ID as appropriate for the given datetime range. | postedAfter (string) postedBefore (string) limit (undefined) offset (undefined) sort (undefined) Partner-Code (string) Merchant-Id (string) terminalId (string) orderId (string) fundingId (string) fundingDetailId (string) |
| public/transactional_data/get_transactions_by_id | Returns single Transaction for the given unique ID | id (string) |
| public/transactional_data/get_transactions_transaction_summaries | Return a list of all transaction summaries for the days within the given date range, restricted by your allianceCode, partnerCode or merchant ID as appropriate. | postedAfter (string) postedBefore (string) limit (undefined) offset (undefined) Partner-Code (string) Merchant-Id (string) |
| public/transactional_data/get_fundings | Return a list of all funding records, restricted by your allianceCode, partnerCode or merchant ID as appropriate for the given datetime range. | fundedAfter (string) fundedBefore (string) limit (undefined) offset (undefined) sort (undefined) fundingDetailId (string) Partner-Code (string) Merchant-Id (string) |
| public/transactional_data/get_fundings_by_id | Returns a single Funding for the given unique ID | id (string) |
| public/transactional_data/get_fundings_by_id_details | Lists the Funding Detail rows for a specific Funding | id (string) |
| public/transactional_data/get_fundings_funding_summaries | Return a funding summary which contains a combined total of all fundings in the given date range, as well as daily summaries for the days within the given date range, restricted by your allianceCode, partnerCode or merchant ID as appropriate. | fundedAfter (string) fundedBefore (string) limit (undefined) offset (undefined) Partner-Code (string) Merchant-Id (string) |
| omni/documents/get_documents | List documents | createdAfter (string) createdBefore (string) modifiedAfter (string) modifiedBefore (string) offset (integer) limit (integer) Type (string) Document-Reference (string) Other-Reference (string) Financial-Reference (string) Id-Reference (string) Sub-Type (string) Title (string) Partner-Code (string) Merchant-Id (string) |
| omni/documents/get_documents_by_id | Get document by ID and type | id (string) Partner-Code (string) Type (string) required Content (boolean) |
| omni/documents/patch_documents_by_id | Update document by ID and type. Please note that when updating content or filename fields you must include both of these at the same time otherwise your update will fail. | id (string) Partner-Code (string) Message-Signature (string) data: { . type . title . description . filename . content . idReference . financialReference . otherReference . signatureMethod . merchantId . generated } (object) required |
| omni/documents/delete_documents_by_id | Delete a document by ID and type | id (string) Partner-Code (string) Type (string) required |
| omni/documents/post_documents_identification | Upload a new identification document which is a specific type of application document, related to the identification of an application. Identification documents are created to support the boarding application process. | Partner-Code (string) Message-Signature (string) data: { . title . description . filename . content . documentReference . idReference . requestType . subType . merchantId . generated } (object) required |
| omni/documents/post_documents_financial | Upload a new financial document which is a specific type of application document, related to financial information of an application. Financial documents are created to support the Boarding Application approval process. | Partner-Code (string) Message-Signature (string) data: { . title . description . filename . content . financialReference . documentReference . requestType . subType . merchantId . generated } (object) required |
| omni/documents/post_documents_contract | Upload a new contract document which is the actual contract document signed during the boarding process. | Partner-Code (string) Message-Signature (string) data: { . title . description . filename . content . documentReference . signatureMethod . requestType . subType . merchantId . generated } (object) required |
| omni/documents/post_documents_other | Upload a new other document which is any application document that is not specifically used for financial or identification purposes within the boarding application approval process. | Partner-Code (string) Message-Signature (string) data: { . title . description . filename . content . documentReference . otherReference . requestType . subType . merchantId . generated } (object) required |
| omni/documents/post_document_signatures | Initiate a new document signing process. Each signing object in the array contains one individual signing one or more documents. | data: { . signings (array) } (object) required |
| omni/documents/put_document_signatures_by_id | Update a previously initiated document signing process | id (string) data: { . signings (array) } (object) required |
| omni/documents/get_document_signatures_by_id | Retrieve an intiated document signing process | id (string) |
| omni/documents/delete_document_signatures_by_id | Cancel the document signing process | id (string) |
| omni/epos_payments/post_nexo_messages | This API endpoint is provides a synchronous interface for nexo Retailer messages. Responds with nexo Retailer message from payment terminal Fiserv SmartPOS - PAX A920 for messages where card is present. Responds with nexo Retailer message from payment gateway IPG for messages where card is not present. | Message-Signature (string) required data: { . SaleToPOIRequest } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_contacts | Retrieve all contacts | merchantApplicationId (string) offset (integer) limit (integer) sort (string) filter (string) |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_contacts | Create a contact | merchantApplicationId (string) Idempotency-Key (string) required data: { . title . firstName . middleName . lastName . contactType . jobTitle . address . phoneNumber } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_contacts_by_contact_id | Retrieve a contact | merchantApplicationId (string) contactId (string) |
| omni/merchant_boarding/delete_merchant_applications_by_merchant_application_id_contacts_by_contact_id | Delete a contact | merchantApplicationId (string) contactId (string) |
| omni/merchant_boarding/patch_merchant_applications_by_merchant_application_id_contacts_by_contact_id | Update a contact | merchantApplicationId (string) contactId (string) Idempotency-Key (string) required data: { . title . firstName . middleName . lastName . contactType . jobTitle . address . phoneNumber } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_bank_accounts | Retrieve all bank accounts | merchantApplicationId (string) offset (integer) limit (integer) sort (string) filter (string) |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_bank_accounts | Create a bank account | merchantApplicationId (string) Idempotency-Key (string) required data: { . accountHolderName . bankAccountCurrency . accountNumber . sortCode . iban . swift . daysCredit . daysDebit . bankName . creditorId . bankAddress } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_bank_accounts_by_bank_account_id | Retrieve a bank account | merchantApplicationId (string) bankAccountId (string) |
| omni/merchant_boarding/delete_merchant_applications_by_merchant_application_id_bank_accounts_by_bank_account_id | Delete a bank account | merchantApplicationId (string) bankAccountId (string) |
| omni/merchant_boarding/patch_merchant_applications_by_merchant_application_id_bank_accounts_by_bank_account_id | Update a bank account | merchantApplicationId (string) bankAccountId (string) Idempotency-Key (string) required data: { . accountHolderName . bankAccountCurrency . accountNumber . sortCode . iban . swift . daysCredit . daysDebit . bankName . creditorId . bankAddress } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_owners | Retrieve all owners | merchantApplicationId (string) offset (integer) limit (integer) sort (string) filter (string) |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_owners | Create an owner | merchantApplicationId (string) Idempotency-Key (string) required data: { . title . firstName . middleName . lastName . dateOfBirth . nationality . placeOfBirth . countryCodeOfResidency . sex . jobTitle . ownerType . ownerPosition . ownershipPercentage . phoneNumber . signatoryType . contractSigner . addresses (array) } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_owners_by_owner_id | Retrieve an owner | merchantApplicationId (string) ownerId (string) |
| omni/merchant_boarding/delete_merchant_applications_by_merchant_application_id_owners_by_owner_id | Delete an owner | merchantApplicationId (string) ownerId (string) |
| omni/merchant_boarding/patch_merchant_applications_by_merchant_application_id_owners_by_owner_id | Update an owner | merchantApplicationId (string) ownerId (string) Idempotency-Key (string) required data: { . title . firstName . middleName . lastName . dateOfBirth . nationality . placeOfBirth . countryCodeOfResidency . sex . jobTitle . ownerType . ownerPosition . ownershipPercentage . phoneNumber . signatoryType . contractSigner . addresses (array) } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_stores | Retrieve all stores | merchantApplicationId (string) offset (integer) limit (integer) sort (string) filter (string) |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_stores | Create an store | merchantApplicationId (string) Idempotency-Key (string) required data: { . acquiringOffer . equipmentOffer . bankAccounts (array) . contacts (array) . tradeName . mcc . storeWebsite . currencyCode . clientRegion (string) . clientRegionSystemId (string) . annualTurnover (string) . annualCardTurnover (string) . delivery0DaysPerc (string) . delivery1To7DaysPerc (string) . delivery8To14DaysPerc (string) . delivery15To30DaysPerc (string) . deliveryOver30DaysPerc (string) . estimateAverageTicket (string) . prodServSold (string) . recurringPaymentsFlag (boolean) . salesFtfPerc (string) . salesInternetPerc (string) . salesMotoPerc (string) . externalMerchantId . businessType . storeType } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_stores_by_store_id | Retrieve a store | merchantApplicationId (string) storeId (string) |
| omni/merchant_boarding/delete_merchant_applications_by_merchant_application_id_stores_by_store_id | Delete a store | merchantApplicationId (string) storeId (string) |
| omni/merchant_boarding/patch_merchant_applications_by_merchant_application_id_stores_by_store_id | Update a store | merchantApplicationId (string) storeId (string) Idempotency-Key (string) required data: { . acquiringOffer . equipmentOffer . bankAccounts (array) . contacts (array) . tradeName . mcc . storeWebsite . currencyCode . clientRegion (string) . clientRegionSystemId (string) . annualTurnover (string) . annualCardTurnover (string) . delivery0DaysPerc (string) . delivery1To7DaysPerc (string) . delivery8To14DaysPerc (string) . delivery15To30DaysPerc (string) . deliveryOver30DaysPerc (string) . estimateAverageTicket (string) . prodServSold (string) . recurringPaymentsFlag (boolean) . salesFtfPerc (string) . salesInternetPerc (string) . salesMotoPerc (string) . externalMerchantId . businessType . storeType } (object) required |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_bulk_stores | Create multiple stores in one request, to be updated individually later on before submission | merchantApplicationId (string) Idempotency-Key (string) required data: { . numberOfPhysicalStores (integer) . numberOfOnlineStores (integer) } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_businesses | Retrieve all businesses | merchantApplicationId (string) offset (integer) limit (integer) sort (string) filter (string) |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_businesses | Create a business | merchantApplicationId (string) Idempotency-Key (string) required data: { . bankAccounts (array) . contacts (array) . mcc . merchantLanguage . legalName . tradeName . registrationCountry . taxId . customFields (array) . externalMerchantId . crmAccountId . crmContactId . aggregateAnnualTurnover . aggregateAnnualCardTurnover . stores (array) . childBusinesses (array) } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_businesses_by_business_id | Retrieve a business | merchantApplicationId (string) businessId (string) |
| omni/merchant_boarding/delete_merchant_applications_by_merchant_application_id_businesses_by_business_id | Delete a business | merchantApplicationId (string) businessId (string) |
| omni/merchant_boarding/patch_merchant_applications_by_merchant_application_id_businesses_by_business_id | Update a business | merchantApplicationId (string) businessId (string) Idempotency-Key (string) required data: { . bankAccounts (array) . contacts (array) . mcc . merchantLanguage . legalName . tradeName . registrationCountry . taxId . customFields (array) . externalMerchantId . crmAccountId . crmContactId . aggregateAnnualTurnover . aggregateAnnualCardTurnover . stores (array) . childBusinesses (array) } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_ownership_entities | Retrieve all ownership entities | merchantApplicationId (string) offset (integer) limit (integer) sort (string) filter (string) |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_ownership_entities | Create an ownership entity | merchantApplicationId (string) Idempotency-Key (string) required data: { . legalName . foundationDate . ownershipEntityType . companyRegistrationNumber . charityRegistrationNumber . taxId . owners (array) } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id_ownership_entities_by_ownership_entity_id | Retrieve an ownership entity | merchantApplicationId (string) ownershipEntityId (string) |
| omni/merchant_boarding/delete_merchant_applications_by_merchant_application_id_ownership_entities_by_ownership_entity_id | Delete an ownership entity | merchantApplicationId (string) ownershipEntityId (string) |
| omni/merchant_boarding/patch_merchant_applications_by_merchant_application_id_ownership_entities_by_ownership_entity_id | Update an ownership entity | merchantApplicationId (string) ownershipEntityId (string) Idempotency-Key (string) required data: { . legalName . foundationDate . ownershipEntityType . companyRegistrationNumber . charityRegistrationNumber . taxId . owners (array) } (object) required |
| omni/merchant_boarding/get_merchant_applications | Retrieve all merchant applications | offset (integer) limit (integer) sort (string) Partner-Code (string) filter (string) |
| omni/merchant_boarding/post_merchant_applications | Create a merchant application | Idempotency-Key (string) required Partner-Code (string) data: { . allianceCode . partnerCode . applicationStatusCode . interventionReasonCode . interventionReasonDescription . businessId (string) . ownershipEntityId (string) . documents (array) . crmOpportunityId . crmLeadId . salesContractDate . sellerInformation (object) . customFields (array) } (object) required |
| omni/merchant_boarding/get_merchant_applications_by_merchant_application_id | Retrieve a merchant application | merchantApplicationId (string) |
| omni/merchant_boarding/delete_merchant_applications_by_merchant_application_id | Delete a merchant application | merchantApplicationId (string) |
| omni/merchant_boarding/patch_merchant_applications_by_merchant_application_id | Update a merchant application | merchantApplicationId (string) Idempotency-Key (string) required Partner-Code (string) data: { . allianceCode . partnerCode . applicationStatusCode . interventionReasonCode . interventionReasonDescription . businessId (string) . ownershipEntityId (string) . documents (array) . crmOpportunityId . crmLeadId . salesContractDate . sellerInformation (object) . customFields (array) } (object) required |
| omni/merchant_boarding/get_full_merchant_applications | Retrieve all full merchant applications | Partner-Code (string) offset (integer) limit (integer) sort (string) filter (string) |
| omni/merchant_boarding/post_full_merchant_applications | Create a full merchant application | Idempotency-Key (string) required Partner-Code (string) data: { . allianceCode . partnerCode . applicationStatusCode . interventionReasonCode . interventionReasonDescription . business . ownershipEntity . documents (array) . crmOpportunityId . crmLeadId . salesContractDate . sellerInformation (object) . customFields (array) } (object) required |
| omni/merchant_boarding/get_full_merchant_applications_by_merchant_application_id | Retrieve a full merchant application | merchantApplicationId (string) |
| omni/merchant_boarding/delete_full_merchant_applications_by_merchant_application_id | Delete a full merchant application | merchantApplicationId (string) |
| omni/merchant_boarding/put_full_merchant_applications_by_merchant_application_id | Update a merchant application | merchantApplicationId (string) Idempotency-Key (string) required Partner-Code (string) data: { . allianceCode . partnerCode . applicationStatusCode . interventionReasonCode . interventionReasonDescription . business . ownershipEntity . documents (array) . crmOpportunityId . crmLeadId . salesContractDate . sellerInformation (object) . customFields (array) } (object) required |
| omni/merchant_boarding/post_merchant_applications_by_merchant_application_id_submit | Submitting a merchant application with result in the applicationStatusCode changing to APPLICATION_READY_FOR_BOARDING. This will automatically start the process to complete boarding of a new merchant onto Fiserv systems. Once an application is submitted, it can no long be edited. | merchantApplicationId (string) |
| omni/terminals/get_terminals | Retrieve a list of all terminals, restricted by your allianceCode, partnerCode or merchant ID as appropriate for the given filter parameters. | Partner-Code (string) activatedAfter (string) activatedBefore (string) Merchant-Id (string) serialNumber (string) status (string) sort (string) limit (undefined) offset (undefined) company (string) client (string) clientId (string) secondaryId (string) |
| omni/terminals/get_terminals_by_id | Retrieve data about an individual Terminal for a given ID | id (string) |
| omni/terminals/post_terminals_by_id_devices | Update the terminal record when a terminal has been attached or detached from another device | id (string) data (undefined) required |