You can manage already configured payment methods using the Management API.
Update a payment method
To update the settings of a payment method, make a PATCH with your merchant account in the path. In your request, specify:
| Parameter | Required | Description |
|---|---|---|
| countries | The list of countries to enable with the payment method. If sent empty, then all countries are supported by the payment method. | |
| currencies | The list of currencies to enable with the payment method. If sent empty, then all currencies are supported by the payment method. | |
| enabled | Indicates whether the payment method is enabled (true) or disabled (false). |
Here's an example of requesting to update Visa payment method by adding support for cards issued in the United States:
The response contains the id of the requested payment method and the updated list of payment method settings.
Get payment method details
You can get the details of a single payment method available on the merchant account or all payment methods available on the merchant account, store, and business line.
Get the details of a specific payment method
To get the details of a single payment method available on the merchant account, make a GET request with your merchant account and the payment method ID in the path.
Get the details of all payment methods
To get the details of all payment methods available on the merchant account, make a GET /merchants/{merchantId}/paymentMethodSettings request with your merchant account in the path.
You can filter the response using the following query parameters:
- storeId: The unique identifier of the store for which to return the payment methods.
- businessLineId: The unique identifier of the business line for which to return the payment methods.
Webhooks
After the payment method has been added to your store, you'll receive a paymentMethod.created webhook. The webhook shows the final state of a payment method setup request.
Here's an example of the webhook you receive after adding Visa to your payment methods: