Remove payment configuration

Removes an existing payment configuration from an app so it can no longer be used to process WhatsApp Pay transactions.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Body

KeyDescriptionValuesData TypeRequired/Optional
configuration_nameName of the payment configuration to act on.payment_config_1—Required
redirect_urlURL the payer is returned to after payment. Required when regenerating a link, ignored when removing a configuration.https://merchant.com/callback—Optional

Sample cURL — Remove payment configuration.

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/payment/configuration/remove' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "configuration_name" : "payment_config_1",
  "redirect_url" : "https://merchant.com/callback"
}'

Sample success response (200)

{
  "status": "success",
  "data": {
    "success": true
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Body Params

Identifies a payment configuration to regenerate a link for, or to remove

string
required

Name of the payment configuration to act on.

string

URL the payer is returned to after payment. Required when regenerating a link, ignored when removing a configuration.

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json