1. Home
  2. Ecommerce Rest Api
  3. WordPress WooCommerce
  4. Payment Gateways

Payment Gateways

Prerequisites

  • WooCommerce API Keys: You need Consumer Key and Consumer Secret.
  • Base URL: Replace https://yourstore.com with your actual WooCommerce store URL.
  • Authorization: Basic Auth with your Consumer Key and Consumer Secret.

Authorization Setup in Postman

  1. Go to the Authorization tab.
  2. Select Type: Basic Auth.
  3. Username: Enter your Consumer Key.
  4. Password: Enter your Consumer Secret.

1. List Payment Gateways

  • URL: https://yourstore.com/wp-json/wc/v3/payment_gateways
  • Method: GET
  • Headers:
    • Authorization: Basic Auth

Example in Postman:

  1. Set method to GET.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/payment_gateways
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Send the request.

2. Retrieve a Payment Gateway

  • URL: https://yourstore.com/wp-json/wc/v3/payment_gateways/{id}
  • Method: GET
  • Headers:
    • Authorization: Basic Auth
  • Replace {id} with the actual payment gateway ID.

Example in Postman:

  1. Set method to GET.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/payment_gateways/{id}
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Send the request.

3. Update a Payment Gateway

  • URL: https://yourstore.com/wp-json/wc/v3/payment_gateways/{id}
  • Method: PUT
  • Headers:
    • Authorization: Basic Auth
  • Body: JSON with updated payment gateway data.
  • Replace {id} with the actual payment gateway ID.

Example JSON Body:

{
  "enabled": true,
  "title": "Updated Payment Gateway Title",
  "description": "This is an updated payment gateway description",
  "settings": {
    "key": "value"
  }
}

Example in Postman:

  1. Set method to PUT.
  2. Enter URL: https://yourstore.com/wp-json/wc/v3/payment_gateways/{id}
  3. Go to the Authorization tab and set Type to Basic Auth.
  4. Enter Consumer Key and Consumer Secret.
  5. Go to the Body tab, select raw, choose JSON from the dropdown, and paste the example JSON body.
  6. Send the request.

By following these instructions, you can test each WooCommerce payment gateways endpoint in Postman. Each request should include the necessary Authorization header configured through Basic Auth with your Consumer Key and Consumer Secret. Adjust the {id} parameter with the actual payment gateway ID you intend to work with for retrieving or updating operations.

How can we help?