# Use cases source: https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/index.md Note: All dates and times are listed in Universal Time Coordinated (UTC). ## Enhanced card payment acceptance use cases {#enhanced-card-payment-acceptance-use-cases} For more information on how to initiate card payment between Buyers and Suppliers in the Commercial Direct Payments, see the [Enhanced card payment acceptance](https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/commercial-direct-payments/enhanced-card-payment-initiation/index.md) section. | API | Request URI | Description | Regional availability | |----------------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------|-----------------------| | Get Payment Instructions for Creditor Agents | **GET** /creditor-agents/{ica}/payment-acceptances/{instruction_identification} | This endpoint allows enquiry of a submitted Payment Instruction. | Global | | Update transaction status | **PUT** /creditor-agents/{ica}/payment-acceptances/{instruction_identification} | This endpoint allows creditor agent to update a card payment instruction. | Global | ## Manage registration use cases {#manage-registration-use-cases} For more information on how to register your Suppliers in Business Payment Service, see the [Manage Supplier registration](https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/business-payment-service/manage-reg/index.md) section. Note: The Mastercard Business Payment Service assigned ICA is used for agent identification in all service requests for core operations. A customer service provider can use their API credentials to transact on behalf of a customer by providing their customer's ICA number in the request. Direct payment agents can still transact by entering their own ICA when sending a transaction to Mastercard Supplier Payment Agent. | API | Request URI | Description | Regional availability | |-----------------------------------------|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|-----------------------| | Register a Supplier | **POST** /supplier-payment-agents/{ica}/suppliers | This endpoint allows you to register a new Supplier in Business Payment Service. | Global | | Retrieve a single Supplier registration | **GET** /supplier-payment-agents/{ica}/suppliers/{id} | This endpoint allows you to retrieve an existing Supplier registration in Business Payment Service. | Global | | Retrieve all Supplier registration | **GET** /supplier-payment-agents/{ica}/suppliers | This endpoint allows you to retrieve all existing Supplier registrations in Business Payment Service. | Global | | Update a Supplier registration | **PUT** /supplier-payment-agents/{ica}/suppliers/{id} | This endpoint allows you to update an existing Supplier registration in Business Payment Service. | Global | | Update a Supplier profile | **PUT** /supplier-payment-agents/{ica}/suppliers/{id}/profiles/{supplierId} | This endpoint allows you to update an existing Supplier profile in Business Payment Service. | Global | | Delete a Supplier registration | **DELETE** /supplier-payment-agents/{ica}/suppliers/{id} | This endpoint allows you to delete an existing Supplier registration in Business Payment Service. | Global | | Delete a Supplier profile | **DELETE** /supplier-payment-agents/{ica}/suppliers/{id}/profiles/{supplierId}​ | This endpoint allows you to delete an existing Supplier profile in Business Payment Service. | Global | | Retrieve payable finance details | **GET** /supplier-payment-agents/{ica}/supplier-payment-profiles/{supplier_id}/payables-finances | This endpoint returns information on the payable finance flag. | | | Update payable finance details | **PUT** /supplier-payment-agents/{ica}/supplier-payment-profiles/{supplier_id}/payables-finances | This endpoint updates information on the payable finance flag. | | ## Linking use cases {#linking-use-cases} For more information on how to implement linking between Buyers and Suppliers in Business Payment Service, see the [Linking](https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/business-payment-service/linking/index.md) section. | API | Request URI | Description | Regional availability | |---------------------------|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------| | Linking nudge | **POST** /supplier-payment-agents/{ica}/supplier-payment-profiles/{spa_profile}/suggested-buyer-links | This endpoint allows you to nudge a Buyer Payment Agent to initiate a linking request between your Supplier and a Buyer. | Global | | Approve linking | **PUT** /supplier-payment-agents/{ica}/supplier-payment-profiles/{spa_profile}/buyer-links/{bpa_profile} | This endpoint allows you to approve a linking request initiated by a Buyer Payment Agent. | Global | | Reject linking | **PUT** /supplier-payment-agents/{ica}/buyer-links | This endpoint allows you to reject a linking request initiated by a Buyer Payment Agent. | Global | | Delete linking | **DELETE** /supplier-payment-agents/{ica}/supplier-payment-profiles/{spa_profile}/buyer-links/{bpa_profile} | This endpoint allows you to delete an existing, approved link between your Supplier and a Buyer. | Global | | Search and filter linking | **GET** /supplier-payment-agents/{ica}/buyer-supplier-links | This endpoint allows you to search for and filter through existing, approved links between your Supplier and a Buyer. | Global | ## Supplier payment preference use cases {#supplier-payment-preference-use-cases} For more information on how to implement your Suppliers' payment preferences in Business Payment Service, see the [Supplier payment preference](https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/business-payment-service/payment-controls/index.md) section. | API | Request URI | Description | Regional availability | |--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|-----------------------| | Create a new payment preference | **POST** ​/supplier-payment-agents​/{ica}​/suppliers​/{supplier_id}​/payment-preferences​/payment-controls | This endpoint allows you to create a new Supplier payment preference in Business Payment Service. | Global | | Update a payment preference | **PUT** ​/supplier-payment-agents​/{ica}​/suppliers​/{supplier_id}​/payment-preferences​/payment-controls​/{payment_control_id} | This endpoint allows you to make changes to a Supplier payment preference in Business Payment Service. | Global | | Retrieve a Single payment preference | **GET** /supplier-payment-agents/{ica}/suppliers/{supplier_id}/payment-preferences/payment-controls/{payment_control_id} | This endpoint allows you to retrieve a single Supplier payment preference. | Global | | Retrieve all payment preferences | **GET** /supplier-payment-agents/{ica}/suppliers/{supplier_id}/payment-preferences/payment-controls | This endpoint allows you to retrieve all existing Supplier payment preferences for a Supplier. | Global | | Delete a single payment preference | **DELETE** /supplier-payment-agents/{ica}/suppliers/{supplier_id}/payment-preferences/payment-controls/{payment_control_id} | This endpoint allows you to delete a single existing Supplier payment preferences for a Supplier. | Global | | Delete all payment preferences | **DELETE** /supplier-payment-agents/{ica}/suppliers/{supplier_id}/payment-preferences/payment-controls | This endpoint allows you to delete all existing Supplier payment preferences for a Supplier. | Global | ## Early payment preference use cases {#early-payment-preference-use-cases} For more information on how to implement your Suppliers' early payment preferences in Business Payment Service, see the [Early payment preference](https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/business-payment-service/early-pay/index.md) section. | API | Request URI | Description | Regional availability | |---------------------------------------------|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|-----------------------| | Update an early payment preference | **PUT** /supplier-payment-agents/{ica}/suppliers/{supplier_id}/payment-preferences/global-finance-rates | This endpoint allows you to update a Supplier's early payment preferences. | United States | | Retrieve Supplier early payment preferences | **GET** /supplier-payment-agents/{ica}/suppliers/{supplier_id}/payment-preferences/global-finance-rates | This endpoint allows you to retrieve a Supplier's early payment preferences. | United States | | Delete an early payment preference | **DELETE** /supplier-payment-agents/{ica}/suppliers/{supplier_id}/payment-preferences/global-finance-rates | This endpoint allows you to delete a Supplier's early payment preferences. | United States | ## Payment instruction use cases {#payment-instruction-use-cases} To integrate with the card and A2A payment instruction APIs, see the [Payment instructions](https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/business-payment-service/payment-instruction/index.md) section. Alert: The Mastercard Business Payment Service assigned ICA is used for agent identification in all service requests for core operations. A customer service provider can use their API credentials to transact on behalf of a customer by providing their customer's ICA number in the request. Direct payment agents can still transact by entering their own ICA when sending a transaction to Mastercard Track Business Payment Service. | API | Request URI | Description | Regional availability | |---------------------------------------------------|---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| | Update card payment instructions | **PUT** /supplier-payment-agents/{ica}/payment-instructions/{transaction_id} | This endpoint allows you to update card payment instructions requests. | Global | | Update A2A payment instructions | **PUT** /supplier-payment-agents/{ica}/payment-instructions/{transaction_id}/bank-account-details | This endpoint allows you to update A2A payment instructions requests and provide bank account information. | United States, United Kingdom, European Economic Area | | Retrieve A2A and card payment instruction details | **GET** /supplier-payment-agents/{ica}/payment-instructions/{transaction_id} | This endpoint returns payment instructions and the payment status. | **A2A** : United States, United Kingdom, European Economic Area **Card**: Global | ## Supply chain finance use case {#supply-chain-finance-use-case} To create a payment instruction for supply chain finance, see the [Supply chain finance](https://developer.mastercard.com/mastercard-supplier-payment-agent/documentation/use_cases/business-payment-service/supply-chain-finance/index.md) section. | API | Request URI | Description | Regional availability | |------------------------------------------------------------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-----------------------| | Submit an A2A payment instruction for supply chain finance | **POST** /buyer-payment-agents/{ica}/payment-instructions | This endpoint allows you to submit a payment instruction for supply chain financing. | United States | | Update a supply chain finance payment instruction status | **PUT** /buyer-payment-agents/{ica}/payment-instructions/{transaction_id} | This endpoint allows you to update the supply chain finance payment status. | United States |