GOgocardless
Customer Notification

Handle a notification

"Handling" a notification means that you have sent the notification yourself (and don't want GoCardless to send it). If the notification has already been actioned, or the deadline to notify has passed, this endpoint will return an already_actioned error and you should not take further action. This endpoint takes no additional parameters.

post/customer_notifications/{customer_notification_id}/actions/handle

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

customer_notification_idstring required

The customer notification id

Headers

GoCardless-Versionstring required

Request body

customer_notificationsobject

Response

Action completed successfully

Example response

{
  "customer_notifications": {
    "id": "EV1D18JEXAMPLE",
    "type": "payment_created",
    "links": {
      "payment": "PM123",
      "mandate": "MD123",
      "refund": "RF123",
      "subscription": "SB123",
      "customer": "CU123",
      "event": "EV123"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.